Account and Instances

View Webhook

Returns the webhook URL configured for the instance. The webhook receives real-time events (messages, status, etc). ⚠️ URL WARNING: {id} is already in the path: do NOT add it twice. ✅ Correct: GET /api/v1/instances/YOUR-INSTANCE-ID/webhook ❌ Wrong: GET /api/v1/YOUR-INSTANCE-ID/instances/YOUR-INSTANCE-ID/webhook (duplicated instanceId)

GEThttps://api.zapzapapi.com/api/v1/instances/{id}/webhook

Authentication with the x-api-key and x-api-secret headers.

Parameters

Name	Type	In	Required	Description
`id`	text	path	Yes	Instance ID

Request example

curl

curl -X GET "https://api.zapzapapi.com/api/v1/instances/{id}/webhook" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/instances/{id}/webhook", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
  },
});
console.log(await res.json());

Python

import requests

res = requests.get(
    "https://api.zapzapapi.com/api/v1/instances/{id}/webhook",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
)
print(res.json())

Response example

JSON

{
  "webhook_url": "https://meusite.com/webhook",
  "configured": true
}

Values are illustrative; the fields follow the real response format.

Other endpoints in this category

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.

Create free account View the documentation