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

object[]Optional

get

HTTPcURLJavaScriptPython

GET /v1/webhooks HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

[
  {
    "id": "text",
    "name": "text",
    "active": true,
    "serverUrl": "https://example.com",
    "webhookHeaders": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "events": [
      "incoming_whatsapp_message"
    ],
    "createdAt": "2025-04-21T18:07:09.592Z",
    "updatedAt": "2025-04-21T18:07:09.592Z"
  }
]

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

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/webhooks HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-04-21T18:07:09.592Z",
  "updatedAt": "2025-04-21T18:07:09.592Z"
}

200

200 response

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-04-21T18:07:09.592Z",
  "updatedAt": "2025-04-21T18:07:09.592Z"
}

Get Webhook By Id

Retrieve details of a specific webhook subscription.

get

Authorizations

Path parameters

webhookIdstringRequired

Header parameters

x-api-keystringRequired

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /v1/webhooks/{webhookId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-04-21T18:07:09.592Z",
  "updatedAt": "2025-04-21T18:07:09.592Z"
}

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

objectOptional

put

HTTPcURLJavaScriptPython

PUT /v1/webhooks/{webhookId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-04-21T18:07:09.592Z",
  "updatedAt": "2025-04-21T18:07:09.592Z"
}

200

200 response

{
  "id": "text",
  "name": "text",
  "active": true,
  "serverUrl": "https://example.com",
  "webhookHeaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "events": [
    "incoming_whatsapp_message"
  ],
  "createdAt": "2025-04-21T18:07:09.592Z",
  "updatedAt": "2025-04-21T18:07:09.592Z"
}

Delete Webhook

Remove a webhook subscription.

delete

Authorizations

Path parameters

webhookIdstringRequired

Header parameters

x-api-keystringRequired

Responses

application/json

objectOptional

delete

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/{webhookId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "success": true
}