Subscribing to channel created webhooks

When you make a request to install a new WhatsApp connector, this is an asynchronous process so you can subscribe the channel created webhook as follows

Set up a webhook subscription

post

/organizations/{organization_id}/workspaces/{workspace_id}/webhook-subscription

Path parameters

organization_idstringrequired

The ID of the organization

workspace_idstringrequired

The ID of the workspace

Body

servicestring

eventstring

templatestring

urlstring

signingKeystring

eventFiltersobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organizations/{organization_id}/workspaces/{workspace_id}/webhook-subscription' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "text",
    "event": "text",
    "template": "text",
    "url": "text",
    "signingKey": "text",
    "eventFilters": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }'

200

400

200

No body

Successful response

Example

Replace {{webhook_url}} with an endpoint you will recieve webhooks and {{signing_key}} is a secret you can use to verify the webhook

curl --location 'https://api.bird.com/workspaces/<your-workspace-id>/numbers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: AccessKey <your-access-key>' \
--data '{
  "service": "channels",
  "event": "channel.created",
  "url": "{{webhook_url}}",
  "signingKey": "{{signing_key}}",
  "eventFilters": []
}'

Example webhook

Below is a sample channels created event:

{
  "service": "channels",
  "event": "channel.created",
  "organizationiD": "{{orgId}}
  "workspaceId": "{{workspaceId}}"
  "payload": {
      "id": "{{channelid}}",        
      "platformId": "whatsapp"
      "connectorId": "{{connectorid}}"
      "identifier": {{whatsappphoneid}}
      "name": {{channelname}}
      "status": "active"
  }
}