{
"id": "wh627c8640675de8fc689ab9d9",
"url": "https://httpbin.org/anything?tag=api",
"enabledEvents": [
"whatsapp.message.updated",
"whatsapp.inbound_message.received"
],
"eventProperties": [
{
"event": "contact.attributes_changed",
"properties": [
"attr1",
"attr2"
]
}
],
"description": "My first webhook endpoint.",
"status": "active",
"secret": "whsec_abc4147651944f02baf3be1eb45d33f1",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z"
}Create a webhook endpoint
Creates a webhook endpoint listening for specific events.
{
"id": "wh627c8640675de8fc689ab9d9",
"url": "https://httpbin.org/anything?tag=api",
"enabledEvents": [
"whatsapp.message.updated",
"whatsapp.inbound_message.received"
],
"eventProperties": [
{
"event": "contact.attributes_changed",
"properties": [
"attr1",
"attr2"
]
}
],
"description": "My first webhook endpoint.",
"status": "active",
"secret": "whsec_abc4147651944f02baf3be1eb45d33f1",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z"
}Authorizations
Body
The URL of the webhook endpoint.
500"https://httpbin.org/anything?tag=api"
The list of events to enable for this endpoint.
Type of event.
email.delivery.updated, sms.message.updated, sms.inbound.received, voice.message.updated, whatsapp.business_account.deleted, whatsapp.business_account.reviewed, whatsapp.business_account.updated, whatsapp.inbound_message.received, whatsapp.message.updated, whatsapp.group.lifecycle_update, whatsapp.group.participants_update, whatsapp.group.settings_update, whatsapp.group.status_update, whatsapp.smb.history, whatsapp.smb.message.created, whatsapp.phone_number.deleted, whatsapp.phone_number.name_updated, whatsapp.phone_number.quality_updated, whatsapp.phone_number.business_username_updated, whatsapp.template.category_updated, whatsapp.template.correct_category_detection, whatsapp.template.quality_updated, whatsapp.template.reviewed, whatsapp.call.connect, whatsapp.call.terminate, whatsapp.call.status.updated, whatsapp.call.recording.updated, whatsapp.call.transcription.updated, whatsapp.flow.status_change, whatsapp.payment.updated, contact.attributes_changed, contact.created, contact.deleted, contact.unsubscribe.created, contact.unsubscribe.deleted, whatsapp.user.preferences, whatsapp.smb.message.echoes, contact.note.created, contact.note.updated, contact.note.deleted, whatsapp.echo_message.created, whatsapp.echo_message.updated, whatsapp.meta_business_agent.handover.updated Optional configuration for event properties in webhook payloads. Specifies which properties should be included for specific event types.
When enabledEvents contains contact.attributes_changed, this field is required and must contain at least one event property configuration for that event type.
Show child attributes
Show child attributes
[ { "event": "contact.attributes_changed", "properties": ["attr1", "attr2"] } ]
An optional description of what the webhook is used for.
400"My first webhook endpoint."
Webhook endpoint status.
active: Indicates that the webhook endpoint is active, and will receive notifications of events monitored.disabled: Indicates that the webhook endpoint is disabled, and will not receive notifications.pending: Indicates that the webhook endpoint is pending, and will not receive notifications. If a webhook endpoint fails to receive notifications frequently, it changes to pending.
active, disabled, pending Response
Successfully created a webhook endpoint.
Unique ID for the object.
"wh627c8640675de8fc689ab9d9"
The URL of the webhook endpoint.
"https://httpbin.org/anything?tag=api"
The list of events to enable for this endpoint.
[ "whatsapp.message.updated", "whatsapp.inbound_message.received" ]
Optional configuration for event properties in webhook payloads. Specifies which properties should be included for specific event types.
When enabledEvents contains contact.attributes_changed, this field is required and must contain at least one event property configuration for that event type.
Show child attributes
Show child attributes
[ { "event": "contact.attributes_changed", "properties": ["attr1", "attr2"] } ]
An optional description of what the webhook is used for.
"My first webhook endpoint."
Webhook endpoint status.
active: Indicates that the webhook endpoint is active, and will receive notifications of events monitored.disabled: Indicates that the webhook endpoint is disabled, and will not receive notifications.pending: Indicates that the webhook endpoint is pending, and will not receive notifications. If a webhook endpoint fails to receive notifications frequently, it changes to pending.
active, disabled, pending The endpoint's secret, used to generate webhook signatures.
"whsec_abc4147651944f02baf3be1eb45d33f1"