v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB

Webhook

Get Webhooks

get/v2/webhooks

Query parameters

sortBy'name' | 'url' | 'createdBy' | 'integrationCount'

Sort by

Example:name

Sort by

sortDirection'ASC' | 'DESC'

Sort direction

Example:DESC

Sort direction

Response

Get Webhooks

webhookIdstring required

The unique identifier of the webhook

urlstring uri required

The URL of the webhook

eventTypesstring[] required

A list of event types that the webhook listens to

wabaNumbersstring[] required

A list of WABA Numbers associated with the webhook

integrationCountinteger required

The count of integrations associated with the webhook

createdBystring required

The user who created the webhook

namestring required

The name of the webhook

Example response

{
  "webhookId": "abc123",
  "url": "https://example.com/webhook",
  "eventTypes": [
    "MESSAGE_RECEIVED",
    "MESSAGE_SENT"
  ],
  "wabaNumbers": [
    "+919999999999",
    "+918888888888"
  ],
  "integrationCount": 2,
  "createdBy": "admin",
  "name": "My Webhook"
}