v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB

Webhook Payload Object

Test webhooks

Sends a payload to sample URL for webhooks testing.

post/YOUR-WEBHOOK-URL

Headers

YCloud-Signaturestring

Example:t=1654084800,s=8eb70f2acb056c2119acbee8fdd98a889021d9c268bc9ad248a4182c40e31119

Request body

idstring required

Unique ID for the event.

type'contact.attributes_changed' | 'contact.created' | 'contact.deleted' | 'contact.unsubscribe.created' | 'contact.unsubscribe.deleted' | '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.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.quality_updated' | 'whatsapp.template.reviewed' | 'whatsapp.call.connect' | 'whatsapp.call.terminate' | 'whatsapp.call.status.updated' | 'whatsapp.flow.status_change' | 'whatsapp.payment.updated' | 'whatsapp.user.preferences' required

Type of event.

apiVersionstring required

The API version used to render this event.

createTimestring date-time required

The time at which this event was created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Response

The request is successfully accepted.