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 /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-06-21T03:38:30.928Z",
"updatedAt": "2025-06-21T03:38:30.928Z"
}
]
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
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-06-21T03:38:30.928Z",
"updatedAt": "2025-06-21T03:38:30.928Z"
}
200 response
{
"id": "text",
"name": "text",
"active": true,
"serverUrl": "https://example.com",
"webhookHeaders": [
{
"key": "text",
"value": "text"
}
],
"events": [
"incoming_whatsapp_message"
],
"createdAt": "2025-06-21T03:38:30.928Z",
"updatedAt": "2025-06-21T03:38:30.928Z"
}
Get Webhook By Id
Retrieve details of a specific webhook subscription.
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-06-21T03:38:30.928Z",
"updatedAt": "2025-06-21T03:38:30.928Z"
}
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
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-06-21T03:38:30.928Z",
"updatedAt": "2025-06-21T03:38:30.928Z"
}
200 response
{
"id": "text",
"name": "text",
"active": true,
"serverUrl": "https://example.com",
"webhookHeaders": [
{
"key": "text",
"value": "text"
}
],
"events": [
"incoming_whatsapp_message"
],
"createdAt": "2025-06-21T03:38:30.928Z",
"updatedAt": "2025-06-21T03:38:30.928Z"
}
Delete Webhook
Remove a webhook subscription.
DELETE /v1/webhooks/{webhookId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200 response
{
"success": true
}
Last updated