Set multiple webhooks for Phone Number

circle-info

It is only useful in certain non-standard situations. To set up a webhook in a standard way please refer to this articlearrow-up-right.

You can attach multiple Webhook URLs to a single phone number. This can be used to manage additional webhooks, enhancing automation and integration capabilities within your systems. This feature compromises on performance. The more webhooks are attached to a number, the longer messages will take to arrive and be acknowledged, so the overall performance will be impacted. Using only one webhook is recommended for high volume accounts.

All destinations will get cloned incoming notifications from the Messaging API. But, extra webhooks will only get these notifications if the main destination (connected to the phone number) successfully receives them with 200 success code. See our documentation for Best Practices for designing Integrations.

Each phone number is limited to a maximum of 3 unique webhooks. This limit cannot be increased. You cannot attach multiple webhooks to a full WABA, only to specific phone numbers.

circle-exclamation

Enable/Disable Multiple Webhooks

Use this endpoint to enable or disable the Multiple Webhook configuration to a specific phone number.

Webhook names are case-sensitive and function like unique IDs. Therefore, a webhook named "webhook" is considered distinct from "WEBhook." The API will only add a new webhook if the <name> provided in the request does not match with any existing configuration.

To enable or disable the multi-webhook feature, the destination object is not required:

Get list of configured Webhooks

This endpoint retrieves all configured and additional webhooks.

Append additional Webhooks

Using this endpoint, 3 webhooks per phone number can be added. This limit cannot be increased.

Update properties of an existing webhook

To update properties of an existing webhook, use this endpoint and specify the new webhook configuration in the request payload.

Delete a specific webhook configuration by name

To delete an additional webhook, use this endpoint. Remember that if you delete all webhooks, the system will return an empty response when attempting callbacks.

Use this request to retrieve webhook names.

Webhook names are case-sensitive, and function like unique IDs. Therefore, a webhook named "webhook" is considered distinct from."WEBhook". The API will only delete the webhook if the <name> request passed in is an exact match.

Last updated

Was this helpful?