Webhook Setup

ChatYug pushes real-time events to your HTTPS endpoint when customers message you, when delivery status changes, and when cart orders arrive. Configure the destination URL and signing secret in the portal.

Portal configuration steps

  1. Sign in to the ChatYug portal.
  2. Open Webhook Settings (also reachable from API Configuration).
  3. Select your WABA.
  4. Enter your public HTTPS webhook URL (must be reachable from the internet).
  5. Set an optional HMAC secret — strongly recommended for production.
  6. Save the configuration, then use Send Test Event to verify delivery.
Portal action (login required): /webhook-settings

URL requirements

  • Must use HTTPS in production (HTTP may be allowed only in non-production environments when explicitly enabled by ChatYug operations).
  • Must respond with HTTP 2xx to acknowledge receipt. Non-2xx responses trigger retries.
  • Should respond quickly; perform heavy processing asynchronously after acknowledging.

Webhook secret vs API key

Your API key (ck_) authenticates requests from your server to ChatYug. The webhook secret verifies requests from ChatYug to your server. They are independent — never use your API key as the webhook HMAC secret.

Request headers

When a secret is configured, ChatYug sends:

HeaderPurpose
X-Chatyug-Event-IdIdempotency key — typically the Meta message or status ID
X-Chatyug-SignatureHMAC-SHA256 of the raw JSON body when a secret is set

Verification steps: Signature Verification.

Event types

eventTypeWhen fired
messageCustomer sends text, media, button/list reply, or Flow submission (nfm_reply)
statusOutbound message status changes (sent, delivered, read, failed)
orderCustomer submits a WhatsApp native catalog cart order
testSent when you click Send Test Event in Webhook Settings

Full payload shapes: Event Reference.

Retry policy

Failed deliveries retry up to 8 times with backoff intervals of approximately 1, 2, 10, 60, and 180 minutes. Rate limit: 300 events per minute per WABA. Use eventId for idempotent processing on your side.

Details: Retry & Troubleshooting.