> ## 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

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

<Note>For the exhaustive schema-derived catalog, see [all examples](/en/api-reference/guides/examples/webhook-examples/webhook-payload-examples).</Note>

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

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

<Note>For endpoint setup, signature validation, and retry behavior, see [Configure webhooks](/en/api-reference/guides/api-fundamentals/configure-webhooks).</Note>

## Message and template events

<CardGroup cols={2}>
  <Card title="Template review" icon="rectangle-list" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples">
    Handle approved, rejected, paused, disabled, and archived template states.
  </Card>

  <Card title="Message status" icon="message-check" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples">
    Handle sent, delivered, read, and failed outbound messages.
  </Card>

  <Card title="Inbound messages" icon="inbox" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples">
    Parse text, media, location, contact, interactive, commerce, and system messages.
  </Card>

  <Card title="Payment updates" icon="credit-card" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples">
    Process WhatsApp payment transaction changes.
  </Card>
</CardGroup>

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

<CardGroup cols={2}>
  <Card title="Echo message created" icon="clone" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created">
    Store outbound text and media echoes.
  </Card>

  <Card title="Echo message updated" icon="message-check" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated">
    Handle delivered, read, late sent, and failed status updates.
  </Card>

  <Card title="Agent handover updated" icon="arrow-right-arrow-left" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated">
    Observe control handover and understand its correlation limits.
  </Card>
</CardGroup>

## Account, app, and Flow events

<CardGroup cols={2}>
  <Card title="Business account updates" icon="building" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples">
    Handle eligibility, location, violation, restriction, and account state changes.
  </Card>

  <Card title="Business App history" icon="clock-rotate-left" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples">
    Synchronize historical inbound and outbound messages.
  </Card>

  <Card title="Business App message echoes" icon="clone" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples">
    Synchronize messages sent from the WhatsApp Business App.
  </Card>

  <Card title="Flow status" icon="diagram-project" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples">
    Process Flow lifecycle status changes.
  </Card>
</CardGroup>

## Calling and group events

<CardGroup cols={2}>
  <Card title="Call connect" icon="phone" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples">
    Handle SDP offers and answers for WhatsApp calls.
  </Card>

  <Card title="Call status" icon="phone-volume" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples">
    Handle ringing, accepted, and rejected call states.
  </Card>

  <Card title="Call termination" icon="phone-slash" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples">
    Handle completed and failed call termination.
  </Card>

  <Card title="Group lifecycle" icon="users" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples">
    Handle group creation and deletion.
  </Card>

  <Card title="Group participants" icon="user-plus" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples">
    Handle participant and join-request changes.
  </Card>

  <Card title="Group settings" icon="users-gear" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples">
    Handle group subject and description changes.
  </Card>

  <Card title="Group status" icon="circle-exclamation" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples">
    Handle group suspension and reinstatement.
  </Card>
</CardGroup>

## Contact events

<CardGroup cols={2}>
  <Card title="Contact created" icon="user-plus" href="/en/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples">
    Process newly created contacts.
  </Card>

  <Card title="Contact deleted" icon="user-minus" href="/en/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples">
    Remove or reconcile deleted contacts.
  </Card>

  <Card title="Contact attributes changed" icon="pen-to-square" href="/en/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples">
    Process profile, custom attribute, and tag changes.
  </Card>

  <Card title="Contact unsubscribed" icon="user-slash" href="/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples">
    Handle newly created opt-out records.
  </Card>

  <Card title="Contact resubscribed" icon="user-check" href="/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples">
    Handle deleted opt-out records.
  </Card>
</CardGroup>

<Card title="Open the complete payload catalog" icon="brackets-curly" href="/en/api-reference/guides/examples/webhook-examples/webhook-payload-examples">
  Browse every event type and all named payload examples from the OpenAPI specification.
</Card>


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