What it is
This catalog covers all 47 webhook event types in the OpenAPI specification and preserves every named payload example.How it works
Choose an event by its exacttype, expand an example, and use the payload to test routing, deserialization, idempotency, and asynchronous processing in your webhook receiver.
Request
Each example is the JSON body of an HTTPPOST request sent by YCloud. The request also includes a YCloud-Signature header that you must validate before trusting the payload.
Response
Return a2xx response after your application has durably accepted the event.
Payload catalog
whatsapp.message.updated — Final charge for a delivered Max Price message
whatsapp.message.updated — Final charge for a delivered Max Price message
messenger.inbound_message.received — Messenger inbound text
messenger.inbound_message.received — Messenger inbound text
messenger.inbound_message.updated — Messenger inbound text edit
messenger.inbound_message.updated — Messenger inbound text edit
messenger.message.updated — Messenger outbound read snapshot
messenger.message.updated — Messenger outbound read snapshot
messenger.message_reaction.updated — Messenger message reaction
messenger.message_reaction.updated — Messenger message reaction
messenger.message_reaction.updated — Messenger message reaction withdrawn
messenger.message_reaction.updated — Messenger message reaction withdrawn
whatsapp.echo_message.created — Outbound text echo
whatsapp.echo_message.created — Outbound text echo
whatsapp.echo_message.created — Outbound image echo
whatsapp.echo_message.created — Outbound image echo
whatsapp.echo_message.updated — Echo message delivered
whatsapp.echo_message.updated — Echo message delivered
whatsapp.echo_message.updated — Echo message read
whatsapp.echo_message.updated — Echo message read
whatsapp.echo_message.updated — Late sent status after read
whatsapp.echo_message.updated — Late sent status after read
whatsapp.echo_message.updated — Failed echo message
whatsapp.echo_message.updated — Failed echo message
whatsapp.meta_business_agent.handover.updated — Agent hands control to your application
whatsapp.meta_business_agent.handover.updated — Agent hands control to your application
whatsapp.business_account.deleted — WhatsApp Business Account deleted event
whatsapp.business_account.deleted — WhatsApp Business Account deleted event
whatsapp.phone_number.quality_updated — WhatsApp phone number quality updated event
whatsapp.phone_number.quality_updated — WhatsApp phone number quality updated event
contact.attributes_changed — Contact attributes changed event
contact.attributes_changed — Contact attributes changed event
contact.created — Contact created event
contact.created — Contact created event
contact.deleted — Contact deleted event
contact.deleted — Contact deleted event
contact.note.created — Contact note created event
contact.note.created — Contact note created event
contact.note.updated — Contact note updated event
contact.note.updated — Contact note updated event
contact.note.deleted — Contact note deleted event
contact.note.deleted — Contact note deleted event
contact.unsubscribe.created — Customer cancels subscription event
contact.unsubscribe.created — Customer cancels subscription event
contact.unsubscribe.deleted — Customer resumes subscription
contact.unsubscribe.deleted — Customer resumes subscription
whatsapp.phone_number.business_username_updated — Business username revoked and replaced
whatsapp.phone_number.business_username_updated — Business username revoked and replaced
whatsapp.inbound_message.received — User changed BSUID without exposing a phone number
whatsapp.inbound_message.received — User changed BSUID without exposing a phone number
whatsapp.inbound_message.received — User changed number with previous BSUIDs
whatsapp.inbound_message.received — User changed number with previous BSUIDs
whatsapp.phone_number.business_username_updated — WhatsApp phone number Business Username updated event
whatsapp.phone_number.business_username_updated — WhatsApp phone number Business Username updated event
whatsapp.phone_number.business_username_updated — WhatsApp phone number Business Username reserved event
whatsapp.phone_number.business_username_updated — WhatsApp phone number Business Username reserved event
whatsapp.template.correct_category_detection — Utility Direct Send category detection event
whatsapp.template.correct_category_detection — Utility Direct Send category detection event
whatsapp.business_account.updated — Utility Direct Send restriction event
whatsapp.business_account.updated — Utility Direct Send restriction event
whatsapp.template.reviewed — WhatsApp template archived event
whatsapp.template.reviewed — WhatsApp template archived event
whatsapp.template.reviewed — WhatsApp template unarchived event
whatsapp.template.reviewed — WhatsApp template unarchived event
whatsapp.call.connect — WhatsApp call connect event
whatsapp.call.connect — WhatsApp call connect event
whatsapp.call.terminate — WhatsApp call terminate event
whatsapp.call.terminate — WhatsApp call terminate event
whatsapp.call.status.updated — WhatsApp call status updated event
whatsapp.call.status.updated — WhatsApp call status updated event
whatsapp.call.recording.updated — WhatsApp call recording updated event
whatsapp.call.recording.updated — WhatsApp call recording updated event
whatsapp.call.transcription.updated — WhatsApp call transcription updated event
whatsapp.call.transcription.updated — WhatsApp call transcription updated event
whatsapp.group.lifecycle_update — WhatsApp group lifecycle update event
whatsapp.group.lifecycle_update — WhatsApp group lifecycle update event
whatsapp.group.participants_update — WhatsApp group participants update event
whatsapp.group.participants_update — WhatsApp group participants update event
whatsapp.group.settings_update — WhatsApp group settings update event
whatsapp.group.settings_update — WhatsApp group settings update event
whatsapp.group.status_update — WhatsApp group status update event
whatsapp.group.status_update — WhatsApp group status update event
whatsapp.smb.message.created — SMB message created
whatsapp.smb.message.created — SMB message created
whatsapp.smb.message.echoes — WhatsApp Business App text message
whatsapp.smb.message.echoes — WhatsApp Business App text message
whatsapp.smb.history — Inbound history message
whatsapp.smb.history — Inbound history message
whatsapp.smb.history — Outbound history message
whatsapp.smb.history — Outbound history message
whatsapp.smb.history — History synchronization progress
whatsapp.smb.history — History synchronization progress
email.delivery.updated
email.delivery.updated
sms.message.updated
sms.message.updated
sms.inbound.received
sms.inbound.received
voice.message.updated
voice.message.updated
whatsapp.business_account.reviewed
whatsapp.business_account.reviewed
whatsapp.phone_number.deleted
whatsapp.phone_number.deleted
whatsapp.phone_number.name_updated
whatsapp.phone_number.name_updated
whatsapp.template.category_updated
whatsapp.template.category_updated
whatsapp.template.quality_updated
whatsapp.template.quality_updated
whatsapp.flow.status_change
whatsapp.flow.status_change
whatsapp.payment.updated
whatsapp.payment.updated
whatsapp.user.preferences
whatsapp.user.preferences

