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.
200 response
GET /v1/webhooks HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200 response
[
{
"id": "text",
"name": "text",
"active": true,
"serverUrl": "https://example.com",
"webhookHeaders": [
{
"key": "text",
"value": "text"
}
],
"events": [
"incoming_whatsapp_message"
],
"createdAt": "2025-08-07T09:35:37.797Z",
"updatedAt": "2025-08-07T09:35:37.797Z"
}
]
Create Webhook
Register a new webhook subscription.
Unique identifier for the endpoint
Human-readable name for the endpoint
Indicates whether the endpoint is active or not
URL of the server where webhooks are sent
Timestamp of endpoint creation
Timestamp of endpoint update
200 response
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-08-07T09:35:37.797Z",
"updatedAt": "2025-08-07T09:35:37.797Z"
}
200 response
{
"id": "text",
"name": "text",
"active": true,
"serverUrl": "https://example.com",
"webhookHeaders": [
{
"key": "text",
"value": "text"
}
],
"events": [
"incoming_whatsapp_message"
],
"createdAt": "2025-08-07T09:35:37.797Z",
"updatedAt": "2025-08-07T09:35:37.797Z"
}
Get Webhook By Id
Retrieve details of a specific webhook subscription.
200 response
GET /v1/webhooks/{webhookId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200 response
{
"id": "text",
"name": "text",
"active": true,
"serverUrl": "https://example.com",
"webhookHeaders": [
{
"key": "text",
"value": "text"
}
],
"events": [
"incoming_whatsapp_message"
],
"createdAt": "2025-08-07T09:35:37.797Z",
"updatedAt": "2025-08-07T09:35:37.797Z"
}
Update Webhook
Update an existing webhook subscription.
Unique identifier for the endpoint
Human-readable name for the endpoint
Indicates whether the endpoint is active or not
URL of the server where webhooks are sent
Timestamp of endpoint creation
Timestamp of endpoint update
200 response
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-08-07T09:35:37.797Z",
"updatedAt": "2025-08-07T09:35:37.797Z"
}
200 response
{
"id": "text",
"name": "text",
"active": true,
"serverUrl": "https://example.com",
"webhookHeaders": [
{
"key": "text",
"value": "text"
}
],
"events": [
"incoming_whatsapp_message"
],
"createdAt": "2025-08-07T09:35:37.797Z",
"updatedAt": "2025-08-07T09:35:37.797Z"
}
Delete Webhook
Remove a webhook subscription.
200 response
DELETE /v1/webhooks/{webhookId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200 response
{
"success": true
}
Last updated