Parameters
The ID of the webhook to update.
Body
Updated name for the webhook.
Updated URL for the webhook.
The webhook events that you want to receive. Options aremessage.incoming
, message.status
, or recipient.optout
(read more).
Array of phone numbers to receive events for in . If none are provided, webhook will default to all numbers assigned to the campaign.
Response
Whether the update succeeded.
The details of the webhook.
The time the webhook was created
The name of the webhook (optional).
The campaign ID for the webhook.
The events the webhook will receive. (read more)
Subscribed to incoming messages.
Subscribed to message status updates.
Subscribed to recipient opt-outs.
The phone numbers the webhook is subscribed to.
{
"success": true,
"webhook": {
"id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
"createdAt": "2023-12-31T03:07:35.826Z",
"name": "Event Service",
"url": "https://website.com/webhook",
"campaignId": "g1tkV7Eq",
"signature": "aVWS7HTLR9xxMkdE",
"eventTypes": [
"message.incoming",
"message.status"
],
"numbers": [
"+14159436397"
]
}
}