API Configuration Overview
This section explains how to configure ChatYug for programmatic integration. Use these public guides to plan your setup; sign in to the portal only when you need to create keys, save webhook URLs, or run the built-in testing tool.
Public docs vs portal
| Need | Where |
|---|---|
| Endpoint reference, code samples, webhook payload shapes | This documentation site (/documentation/) |
| Request and generate API keys, revoke keys | Portal → API Configuration (login required) |
| Save webhook URL and secret, send test event | Portal → Webhook Settings (login required) |
| Interactive API testing with live request/response | Portal → API Configuration → Testing Tool (login required) |
Ready to configure? Use the top bar Sign in to portal button, or go to /login after you have a ChatYug account.
Setup checklist
- ChatYug account + active WABA — Complete onboarding and connect your WhatsApp Business Account in the portal.
- API key — Submit an approval request, wait for operations approval, then generate and store your
ck_key. See API Keys. - Discover IDs — Call
GET /api/external/meto listwabaIdandphoneNumberIdvalues for your key. See Testing & IDs. - Outbound webhook — Expose an HTTPS endpoint on your server, configure URL + HMAC secret in Webhook Settings. See Webhook Setup.
- First API call — Follow the Quickstart to send a message and verify delivery webhooks.
What you can integrate
Once configured, the External API at https://chatyug.com/api/external supports:
- Messaging — text, templates, media, interactive
- Webhooks — inbound messages, delivery status, cart orders
- Commerce — catalogs, product messages, orders, checkout Flows
- Carousel — approved carousel template sends
Authentication quick reference
All External API calls (except the public health check) use:
Authorization: Bearer ck_your_api_key_here
For header usage and key lifecycle details, see Authentication.