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

What it is

Handle contact unsubscribe creation events.

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.


occurs when the user unsubscribed from the whatsapp message you sent. The webhook payload contains the user’s mobile phone number information and the unsubscribe time.

Contact Unsubscribe Created Example

Request

Response

Acknowledge the delivery after durably accepting the event.

Explanation

  • The unsubscriberChanged object contains the user’s mobile phone number information and the unsubscribe time.