Skip to main content
For the exhaustive schema-derived catalog, see all examples.

​
What it is

Browse event-specific webhook walkthroughs, prerequisites, and payload examples.

​
Before you begin

  • Create a public HTTPS endpoint in your application.
  • Configure a YCloud webhook endpoint for the event types you need.
  • Store the endpoint signing secret securely.
  • Make event processing idempotent.

​
How it works

YCloud sends an HTTP POST request when the event occurs. Verify the signature, durably record the event, return a 2xx response, and process slow work asynchronously.

​
Request

The scenarios below show requests delivered to your webhook URL. Treat the event id as the delivery identifier and use type to route the payload.

​
Response

Return a 2xx status after accepting the event.
For endpoint setup, signature validation, and retry behavior, see Configure webhooks.

​
Message and template events

Template review

Handle approved, rejected, paused, disabled, and archived template states.

Message status

Handle sent, delivered, read, and failed outbound messages.

Inbound messages

Parse text, media, location, contact, interactive, commerce, and system messages.

Payment updates

Process WhatsApp payment transaction changes.

​
Echo and Agent handover events

For Agents onboarded through the Public REST API, use these event-specific walkthroughs. Console-created Agents use a separate Inbox synchronization flow.

Echo message created

Store outbound text and media echoes.

Echo message updated

Handle delivered, read, late sent, and failed status updates.

Agent handover updated

Observe control handover and understand its correlation limits.

​
Account, app, and Flow events

Business account updates

Handle eligibility, location, violation, restriction, and account state changes.

Business App history

Synchronize historical inbound and outbound messages.

Business App message echoes

Synchronize messages sent from the WhatsApp Business App.

Flow status

Process Flow lifecycle status changes.

​
Calling and group events

Call connect

Handle SDP offers and answers for WhatsApp calls.

Call status

Handle ringing, accepted, and rejected call states.

Call termination

Handle completed and failed call termination.

Group lifecycle

Handle group creation and deletion.

Group participants

Handle participant and join-request changes.

Group settings

Handle group subject and description changes.

Group status

Handle group suspension and reinstatement.

​
Contact events

Contact created

Process newly created contacts.

Contact deleted

Remove or reconcile deleted contacts.

Contact attributes changed

Process profile, custom attribute, and tag changes.

Contact unsubscribed

Handle newly created opt-out records.

Contact resubscribed

Handle deleted opt-out records.

Open the complete payload catalog

Browse every event type and all named payload examples from the OpenAPI specification.