Docs

Quick start

Go from zero to a delivered WhatsApp message in four steps.

1. Connect a WhatsApp number

In the dashboard open Settings → WhatsApp numbers and click Connect WhatsApp. Meta's Embedded Signup runs in a popup — choose a new number or bring the number you use in the WhatsApp Business app. It takes about two minutes.

2. Create an API key

Go to Developers → API keys, click Create API key and grant at least the messages:send permission. Copy the secret — it's shown only once.

Terminal
export ENGAGE_API_KEY="egk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Keep keys server-side
Never embed an API key in a browser or mobile app. Anyone holding the key can send messages as your business.

3. Send your first message

New conversations must start with an approved template. Every new WhatsApp account has the hello_world sample template, so you can try it straight away. Use your own phone number as to.

curl https://api.engage.swastik.ai/v1/messages \
  -H "Authorization: Bearer $ENGAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "to": "+919812345678",
    "type": "template",
    "template": {
      "name": "hello_world",
      "language": "en_US"
    }
  }'

The API answers 202 Accepted as soon as the message is safely queued:

Response · 202
{
  "id": "0f9b1c7e-5a43-4c1d-9d0e-6f2a8b3c4d51",
  "status": "queued"
}

4. Track delivery

Register a webhook endpoint under Developers → Webhooks and subscribe to message.status. You'll receive sent, delivered, read or failed updates in real time. You can also poll GET /v1/messages/{id}.

When the customer replies, the 24-hour window opens and you can send free-form text — see Sending messages.