Quickstart - Zapfy Docs

1. Send a message

curl -X POST https://api.zapfy.io/v1/messages/send-text \
  -H "Authorization: Bearer zpfy_inst_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "text": "Hello from Zapfy!"
  }'

The API answers 202 right away with { "data": { "messageId": "3EB0…" } } — the id the message will have on WhatsApp — and sends it next, in the order you asked. The outcome arrives by webhook: MESSAGE.SENT once WhatsApp accepted it (✓ sent); delivery (✓✓), read or a failed send in the MESSAGE.STATUS_UPDATED webhook. You can also read it at GET /v1/messages/{messageId}.

2. Register a webhook

In the dashboard, open the instance → Webhooks & config tab → Add webhook, enter the destination URL and pick the events you want. You can have up to 5 webhooks per instance, each subscribing to its own set of events.

3. Receive events

Zapfy sends a POST to your URL with the canonical envelope:

{
  "type": "MESSAGE.RECEIVED",
  "id": "wh_286b29b031204ca07cfb0a068a89f526",
  "instanceId": "01J9Z...",
  "timestamp": "2026-09-28T12:34:56Z",
  "data": {
    "messageId": "3EB0C767D26A1D8E4F2B",
    "fromMe": false,
    "chat": { "type": "DIRECT", "id": "5511999998888@s.whatsapp.net", "phone": "5511999998888" },
    "sender": { "id": "5511999998888@s.whatsapp.net", "phone": "5511999998888", "name": "John Doe" },
    "messageType": "TEXT",
    "text": "Hi!"
  }
}

Reply 2xx within 10 seconds to acknowledge receipt. On failure, Zapfy retries the event, so the same event can arrive more than once — see Handling events for how to deduplicate.

​1. Send a message

​2. Register a webhook

​3. Receive events

1. Send a message

2. Register a webhook

3. Receive events