Skip to main content
Use the walkthroughs when you are implementing a specific YCloud or WhatsApp scenario. Each page keeps the context around the example, including prerequisites, expected behavior, screenshots, request bodies, response bodies, and operational notes where available. Use the webhook payload catalog when you need to quickly find and copy a payload for any supported event type.

​
How to use the examples

  1. Read the feature guide to understand prerequisites and lifecycle behavior.
  2. Choose the scenario closest to your use case.
  3. Replace every placeholder with a value from your account.
  4. Compare the request with the endpoint schema in the API Reference.
  5. Test webhook handling before relying on delivery or lifecycle updates.
Example IDs, phone numbers, URLs, and API keys are placeholders. Do not copy them into production unchanged.

​
API examples

WhatsApp template creation

Create authentication, utility, marketing, commerce, Flow, and calling templates with annotated examples and screenshots.

WhatsApp messaging

Send template, media, interactive, commerce, Flow, and calling messages with visual examples and implementation notes.

​
Webhook examples

Webhook walkthroughs

Review prerequisites, trigger behavior, lifecycle details, and event-specific payload scenarios.

All webhook payloads

Browse every supported event type and named payload example from the webhook specification.

​
What each example includes

API examples explain the scenario, show a complete request, describe the response contract, and call out implementation details. Webhook examples explain the trigger, show the HTTP request sent to your endpoint, and describe how your endpoint should acknowledge and process it.