> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook examples

> Find triggers, payload syntax, parameters, and examples for every YCloud webhook event.

Look up an event by its exact `type`. Each reference includes **Triggers**, **Syntax**, **Parameters**, and **Example**. This reference covers all 47 event types in the YCloud webhook contract.

YCloud delivers its own event envelope. Use the event names and fields on these pages when you integrate with YCloud.

Before receiving events, [configure a webhook endpoint](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md), subscribe to the event types you need, and validate the `YCloud-Signature` header.

Use the example payloads on each event page to test your receiver.

## Common envelope

Every event includes `id`, `type`, `apiVersion`, and `createTime`. Route by `type` and deduplicate by event `id`. Event-specific payload fields vary by event and scenario.

Verify the signature and durably accept the event before returning a `2xx` response. For retries and receiver setup, see [Configure webhooks](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Messenger

| Event type | Trigger |
| - | - |
| [`messenger.inbound_message.received`](https://docs.ycloud.com/en/api-reference/webhook-reference/messenger-inbound-message-received) | Occurs when an ordinary Messenger text message is received from a customer. |
| [`messenger.inbound_message.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/messenger-inbound-message-updated) | Occurs when a customer edits a saved Messenger inbound text message. |
| [`messenger.message.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/messenger-message-updated) | Occurs when a saved ordinary Messenger outbound message snapshot is available, including submission results and matched receipts. |
| [`messenger.message_reaction.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/messenger-message-reaction-updated) | Occurs when a customer reacts to or removes a reaction from a Messenger message. |

## WhatsApp messages

| Event type | Trigger |
| - | - |
| [`whatsapp.inbound_message.received`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-inbound-message-received) | Occurs when a WhatsApp inbound message is received. |
| [`whatsapp.message.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-message-updated) | Occurs when a WhatsApp outbound message status is updated, and the status changes to `sent`, `failed`, `delivered`, or `read`. |
| [`whatsapp.user.preferences`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-user-preferences) | Occurs when a WhatsApp user stops marketing messages or a WhatsApp user resumes marketing messages. |

## WhatsApp templates

| Event type | Trigger |
| - | - |
| [`whatsapp.template.category_updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-template-category-updated) | Occurs when a WhatsApp template category is updated. |
| [`whatsapp.template.correct_category_detection`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-template-correct-category-detection) | Occurs when Meta detects non-utility content in Utility Direct Send. Subscribe through the webhook endpoint API. |
| [`whatsapp.template.quality_updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-template-quality-updated) | Occurs when a WhatsApp template quality rating is updated. |
| [`whatsapp.template.reviewed`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-template-reviewed) | Occurs when a WhatsApp template receives a review or lifecycle update, including approval, rejection, pausing, disabling, archiving, and unarchiving. |

## WhatsApp accounts

| Event type | Trigger |
| - | - |
| [`whatsapp.business_account.deleted`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-business-account-deleted) | Occurs when a WhatsApp Business Account is deleted. |
| [`whatsapp.business_account.reviewed`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-business-account-reviewed) | Occurs when a WhatsApp Business Account has been reviewed. |
| [`whatsapp.business_account.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-business-account-updated) | Occurs when a policy violation happened, WhatsApp Business Account has been banned and more. |

## WhatsApp phone numbers

| Event type | Trigger |
| - | - |
| [`whatsapp.phone_number.deleted`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-phone-number-deleted) | Occurs when a WhatsApp business phone number is deleted. |
| [`whatsapp.phone_number.name_updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-phone-number-name-updated) | Occurs when a WhatsApp business phone number's name has been approved or rejected. |
| [`whatsapp.phone_number.quality_updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-phone-number-quality-updated) | Occurs when a WhatsApp business phone number's quality, messaging limit, or account connection state is updated. |
| [`whatsapp.phone_number.business_username_updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated) | Occurs when a WhatsApp business phone number's Business Username is updated. |

## WhatsApp Business App

| Event type | Trigger |
| - | - |
| [`whatsapp.smb.history`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-smb-history) | Occurs when WhatsApp Business App message history is synchronized. |
| [`whatsapp.smb.message.created`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-smb-message-created) | Occurs when a message is sent from the WhatsApp Business App. |
| [`whatsapp.smb.message.echoes`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-smb-message-echoes) | Occurs when a message sent from the WhatsApp Business App is synchronized as an echo. |

## WhatsApp Agents

| Event type | Trigger |
| - | - |
| [`whatsapp.echo_message.created`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-echo-message-created) | Occurs when an outbound echo message is recorded for a Public REST API Agent. |
| [`whatsapp.echo_message.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-echo-message-updated) | Occurs when an outbound echo status is received for a Public REST API Agent; late lower-ranked statuses can also be delivered. |
| [`whatsapp.meta_business_agent.handover.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated) | Occurs when a supported handover callback transfers control away from a Public REST API Agent. Does not confirm Inbox assignment. |

## WhatsApp calls

| Event type | Trigger |
| - | - |
| [`whatsapp.call.connect`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-call-connect) | Occurs when an incoming call provides an SDP offer or a business-initiated call provides an SDP answer. |
| [`whatsapp.call.terminate`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-call-terminate) | Occurs when a WhatsApp call is terminated. |
| [`whatsapp.call.status.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-call-status-updated) | Occurs when a WhatsApp call status is updated. |
| [`whatsapp.call.recording.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-call-recording-updated) | Occurs when an API-sourced WhatsApp call recording becomes available or permanently fails. |
| [`whatsapp.call.transcription.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-call-transcription-updated) | Occurs when an API-sourced WhatsApp call transcription becomes available or permanently fails. |

## WhatsApp groups

| Event type | Trigger |
| - | - |
| [`whatsapp.group.lifecycle_update`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-group-lifecycle-update) | Occurs when a WhatsApp group is created or deleted, including successful and failed results. |
| [`whatsapp.group.participants_update`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-group-participants-update) | Occurs when WhatsApp group participants or join requests are updated. |
| [`whatsapp.group.settings_update`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-group-settings-update) | Occurs when WhatsApp group settings are updated, including successful and failed results. |
| [`whatsapp.group.status_update`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-group-status-update) | Occurs when a WhatsApp group suspension status is updated. |

## WhatsApp Flows and payments

| Event type | Trigger |
| - | - |
| [`whatsapp.flow.status_change`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-flow-status-change) | Occurs when a WhatsApp flow status is updated. |
| [`whatsapp.payment.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/whatsapp-payment-updated) | Occurs when a WhatsApp payment transaction changes. |

## Contacts

| Event type | Trigger |
| - | - |
| [`contact.attributes_changed`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-attributes-changed) | Occurs when a contact's attributes are changed. |
| [`contact.created`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-created) | Occurs when a contact is created. |
| [`contact.deleted`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-deleted) | Occurs when a contact is deleted. |
| [`contact.unsubscribe.created`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-unsubscribe-created) | Occurs when a contact unsubscribes from messages. |
| [`contact.unsubscribe.deleted`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-unsubscribe-deleted) | Occurs when a contact resumes subscription to messages. |
| [`contact.note.created`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-note-created) | Occurs when a contact note is created. |
| [`contact.note.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-note-updated) | Occurs when a contact note is updated. |
| [`contact.note.deleted`](https://docs.ycloud.com/en/api-reference/webhook-reference/contact-note-deleted) | Occurs when a contact note is independently deleted. Contact deletion does not emit this event for cascaded notes. |

## Email, SMS, and Voice

| Event type | Trigger |
| - | - |
| [`email.delivery.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/email-delivery-updated) | Occurs when an email delivery status is updated, and the status changes to `delivered` or `failed`. |
| [`sms.message.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/sms-message-updated) | Occurs when an SMS message status is updated, and the status changes to `delivered` or `undelivered`. |
| [`sms.inbound.received`](https://docs.ycloud.com/en/api-reference/webhook-reference/sms-inbound-received) | Occurs when an SMS inbound message is received, which means a user replies to your message. |
| [`voice.message.updated`](https://docs.ycloud.com/en/api-reference/webhook-reference/voice-message-updated) | Occurs when a voice message status is updated, and the status changes to `delivered` or `undelivered`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.