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

​
What it is

Handle WhatsApp group suspension status updates.

​
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.

​
Group Suspended

When a WhatsApp group is suspended, you will receive a webhook with the following payload structure:

​
Request

​
Response

Acknowledge the delivery after durably accepting the event.

​
Explanation

Route the event by type, deduplicate it by id, and move slow or failure-prone work to an asynchronous processor.

​
Group Suspension Cleared

When a WhatsApp group suspension is cleared, you will receive a webhook with the following payload structure:

​
Request

​
Response

Acknowledge the delivery after durably accepting the event.

​
Explanation

  • type: Always whatsapp.group.status_update for group suspension status events
  • whatsappGroup: Contains the group suspension status details
    • field: Always group_status_update
    • type: The status event type, either group_suspend or group_suspend_cleared
    • status: The normalized group status, either suspended or suspend_cleared
    • groupId: The WhatsApp group ID
    • webhookTime: The time at which WhatsApp triggered this webhook