Webhooks

Webhooks allow you to receive real-time notifications when specific events occur. You can subscribe, retrieve, update, and delete webhooks using the API.

Get All Webhooks

Retrieve a list of all registered webhooks.

get

Authorizations

Query parameters

limitstringoptional

pagestringoptional

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/webhooks' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "active": true,
    "serverUrl": "https://example.com",
    "webhookHeaders": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-03-31T09:18:33.195Z",
    "updatedAt": "2025-03-31T09:18:33.195Z"
  }
]

200 response

Create Webhook

Register a new webhook subscription.

post

Authorizations

Header parameters

x-api-keystringrequired

Body

idstringoptional

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstring · urirequired

URL of the server where webhooks are sent

webhookHeadersobject[]optional

Array of HTTP headers to be included in webhook requests

eventsstring · enum[]required

Array of events that trigger webhooks for this endpoint

createdAtstring · date-timeoptional

Timestamp of endpoint creation

updatedAtstring · date-timeoptional

Timestamp of endpoint update

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/webhooks' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "active": true,
    "serverUrl": "https://example.com",
    "webhookHeaders": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-03-31T09:18:33.195Z",
    "updatedAt": "2025-03-31T09:18:33.195Z"
  }'

200

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-03-31T09:18:33.195Z",
  "updatedAt": "2025-03-31T09:18:33.195Z"
}

200 response

Get Webhook By Id

Retrieve details of a specific webhook subscription.

get

Authorizations

Path parameters

webhookIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/webhooks/{webhookId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-03-31T09:18:33.195Z",
  "updatedAt": "2025-03-31T09:18:33.195Z"
}

200 response

Update Webhook

Update an existing webhook subscription.

put

Authorizations

Path parameters

webhookIdstringrequired

Header parameters

x-api-keystringrequired

Body

idstringoptional

Unique identifier for the endpoint

namestringrequired

Human-readable name for the endpoint

activebooleanrequired

Indicates whether the endpoint is active or not

serverUrlstring · urirequired

URL of the server where webhooks are sent

webhookHeadersobject[]optional

Array of HTTP headers to be included in webhook requests

eventsstring · enum[]required

Array of events that trigger webhooks for this endpoint

createdAtstring · date-timeoptional

Timestamp of endpoint creation

updatedAtstring · date-timeoptional

Timestamp of endpoint update

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '<YOUR HOST>/v1/webhooks/{webhookId}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "active": true,
    "serverUrl": "https://example.com",
    "webhookHeaders": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-03-31T09:18:33.195Z",
    "updatedAt": "2025-03-31T09:18:33.195Z"
  }'

200

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-03-31T09:18:33.195Z",
  "updatedAt": "2025-03-31T09:18:33.195Z"
}

200 response

Delete Webhook

Remove a webhook subscription.

delete

Authorizations

Path parameters

webhookIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '<YOUR HOST>/v1/webhooks/{webhookId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response