Browse the docs

Webhook events

Each example below is the whole request body. Only the data part changes from event to event.

WhatsApp

message.received

Someone sent you a WhatsApp message. It is not sent when a person only opens the chat.

Request body
{
  "id": "evt_011c9a0b2d3e4f5061728394",
  "type": "message.received",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "message_id": "cmgx1a2b3c0001",
    "wamid": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQ0Y1",
    "conversation_id": "cmgx1a2b3c0002",
    "type": "text",
    "text": "Is the blue kurta available in M?",
    "button_payload": null,
    "context_wamid": null,
    "received_at": "2026-10-19T10:15:02.000Z",
    "contact": {
      "id": "cmgx1a2b3c0003",
      "phone": "+919876543210",
      "name": "Asha"
    },
    "whatsapp_number": {
      "id": "cmgx1a2b3c0004",
      "phone": "+918000000000"
    }
  }
}
  • type is the message type: text, image, video, audio, document, sticker, location, contacts, button, interactive, reaction or unsupported.
  • text is the text, the caption or the title of the button the person tapped. Message text is cut at 4,096 characters.
  • button_payload is a quick-reply button's payload, or the id of a list or button reply. context_wamid is the message they replied to.
  • The file of a photo, video or document is not sent: type tells you it was one.

message.status

A WhatsApp message you sent moved to sent, delivered, read or failed. A repeat that changes nothing is not sent.

Request body
{
  "id": "evt_021c9a0b2d3e4f5061728394",
  "type": "message.status",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "message_id": "cmgx1a2b3c0010",
    "wamid": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgS",
    "status": "failed",
    "occurred_at": "2026-10-19T10:16:40.000Z",
    "contact": {
      "id": "cmgx1a2b3c0003",
      "phone": "+919876543210"
    },
    "campaign_id": "cmgx1a2b3c0011",
    "whatsapp_number": {
      "id": "cmgx1a2b3c0004",
      "phone": "+918000000000"
    },
    "error": {
      "code": "131026",
      "message": "Message undeliverable"
    }
  }
}
  • status is sent, delivered, read or failed. error is set only for failed.
  • campaign_id is null for a message that was not part of a campaign. contact is null when the person was deleted.
  • message_id is the id the REST API returned when you sent the message, so you can match the two.

Contacts

contact.opted_out

Someone can now get fewer WhatsApp messages: from Subscribed to No offers, or to No messages.

Request body
{
  "id": "evt_031c9a0b2d3e4f5061728394",
  "type": "contact.opted_out",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "contact": {
      "id": "cmgx1a2b3c0003",
      "phone": "+919876543210",
      "name": "Asha"
    },
    "channel": "whatsapp",
    "subscription_status": "unsubscribed",
    "previous_subscription_status": "subscribed",
    "source": "keyword",
    "occurred_at": "2026-10-19T10:20:00.000Z"
  }
}
  • subscription_status and previous_subscription_status are subscribed (offers and updates), unsubscribed ("No offers": updates about things they booked only) or no_messages (nothing at all).
  • source is keyword, sign_up_link, automation, team, api, import, whatsapp_131050, whatsapp_settings, shopify or other.
  • A change made to many contacts at once (a CSV import, a bulk action) is not sent one by one.

contact.opted_in

Someone can get more WhatsApp messages again (START, a sign-up link, your team or the API).

Request body
{
  "id": "evt_041c9a0b2d3e4f5061728394",
  "type": "contact.opted_in",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "contact": {
      "id": "cmgx1a2b3c0003",
      "phone": "+919876543210",
      "name": "Asha"
    },
    "channel": "whatsapp",
    "subscription_status": "subscribed",
    "previous_subscription_status": "unsubscribed",
    "source": "sign_up_link",
    "occurred_at": "2026-10-19T10:25:00.000Z"
  }
}
  • The fields and values are the same as for contact.opted_out.

Templates

template.status_updated

Meta approved, rejected, paused or disabled one of your templates (or its review moved on).

Request body
{
  "id": "evt_051c9a0b2d3e4f5061728394",
  "type": "template.status_updated",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "template_id": "cmgx1a2b3c0020",
    "meta_template_id": "1234567890123456",
    "name": "order_update",
    "language": "en_US",
    "category": "utility",
    "status": "rejected",
    "previous_status": "pending",
    "reason": "INVALID_FORMAT",
    "whatsapp_number": {
      "id": "cmgx1a2b3c0004",
      "phone": null
    }
  }
}
  • status and previous_status are approved, rejected, pending, paused, disabled, in_appeal or deleted.
  • reason is Meta's reason. It is null when the template was approved.
  • whatsapp_number.phone is null when the change came from Meta's account-level notice.

Email

email.delivered

Amazon SES says the email reached the person's mailbox.

Request body
{
  "id": "evt_061c9a0b2d3e4f5061728394",
  "type": "email.delivered",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "email_id": "cmgx1a2b3c0030",
    "kind": "campaign",
    "campaign_id": "cmgx1a2b3c0031",
    "contact_id": "cmgx1a2b3c0003",
    "to": "asha@example.com",
    "occurred_at": "2026-10-19T10:30:00.000Z"
  }
}
  • kind says where the email came from: campaign or api (sent with POST /email/messages; then campaign_id is null). Test emails send no events.

email.bounced

An email bounced: permanently, for now, or for a reason Amazon could not tell.

Request body
{
  "id": "evt_071c9a0b2d3e4f5061728394",
  "type": "email.bounced",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "email_id": "cmgx1a2b3c0030",
    "kind": "campaign",
    "campaign_id": "cmgx1a2b3c0031",
    "contact_id": "cmgx1a2b3c0003",
    "to": "asha@example.com",
    "occurred_at": "2026-10-19T10:30:00.000Z",
    "bounce": {
      "type": "permanent",
      "sub_type": "no_email",
      "message": "The address does not exist"
    }
  }
}
  • kind says where the email came from: campaign or api (sent with POST /email/messages; then campaign_id is null). Test emails send no events.
  • bounce.type is permanent, transient or undetermined. bounce.sub_type is Amazon's sub-type in snake_case, for example general, no_email, suppressed, on_account_suppression_list or mailbox_full.

email.complained

The person marked your email as spam.

Request body
{
  "id": "evt_081c9a0b2d3e4f5061728394",
  "type": "email.complained",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "email_id": "cmgx1a2b3c0030",
    "kind": "campaign",
    "campaign_id": "cmgx1a2b3c0031",
    "contact_id": "cmgx1a2b3c0003",
    "to": "asha@example.com",
    "occurred_at": "2026-10-19T11:02:00.000Z",
    "complaint": {
      "type": "abuse"
    }
  }
}
  • kind says where the email came from: campaign or api (sent with POST /email/messages; then campaign_id is null). Test emails send no events.
  • complaint.type is the mailbox provider's feedback type when it gave one (abuse, fraud, not_spam ...), else null.

email.opened

A person opened a campaign email. Only when open tracking is on; opens by machines are left out.

Request body
{
  "id": "evt_091c9a0b2d3e4f5061728394",
  "type": "email.opened",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "email_id": "cmgx1a2b3c0030",
    "kind": "campaign",
    "campaign_id": "cmgx1a2b3c0031",
    "contact_id": "cmgx1a2b3c0003",
    "to": "asha@example.com",
    "occurred_at": "2026-10-19T12:00:00.000Z",
    "first_open": true
  }
}
  • kind says where the email came from: campaign or api (sent with POST /email/messages; then campaign_id is null). Test emails send no events.
  • Every human open is sent. first_open is true for the first one.

email.clicked

A person clicked a tracked link in a campaign email. Only when click tracking is on.

Request body
{
  "id": "evt_101c9a0b2d3e4f5061728394",
  "type": "email.clicked",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "email_id": "cmgx1a2b3c0030",
    "kind": "campaign",
    "campaign_id": "cmgx1a2b3c0031",
    "contact_id": "cmgx1a2b3c0003",
    "to": "asha@example.com",
    "occurred_at": "2026-10-19T12:00:20.000Z",
    "url": "https://shop.example.com/sale?utm_source=ezreach",
    "link_id": "cmgx1a2b3c0032",
    "first_click": true
  }
}
  • kind says where the email came from: campaign or api (sent with POST /email/messages; then campaign_id is null). Test emails send no events.
  • first_click is true for the first click of that email.

email.unsubscribed

An email address became unsubscribed: the unsubscribe link, the mailbox's one-click button, a spam report, your team, the API or Shopify.

Request body
{
  "id": "evt_111c9a0b2d3e4f5061728394",
  "type": "email.unsubscribed",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "to": "asha@example.com",
    "contact_id": "cmgx1a2b3c0003",
    "source": "one_click",
    "occurred_at": "2026-10-19T12:05:00.000Z"
  }
}
  • source is unsubscribe_link, one_click, complaint, bounce, team, api, shopify, form, import, platform or other.
  • contact_id is null when the address belongs to no contact.

RSVP

rsvp.submitted

Someone completed your RSVP form in WhatsApp (counted or not).

Request body
{
  "id": "evt_121c9a0b2d3e4f5061728394",
  "type": "rsvp.submitted",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "submission_id": "cmgx1a2b3c0040",
    "rsvp_event": {
      "id": "cmgx1a2b3c0041",
      "title": "Diwali tasting evening"
    },
    "contact": {
      "id": "cmgx1a2b3c0003",
      "phone": "+919876543210"
    },
    "name": "Asha Rao",
    "guests": 2,
    "slot": {
      "id": "s1",
      "label": "Saturday 7 pm",
      "starts_at": "2026-10-24T13:30:00.000Z"
    },
    "counted": true,
    "problem": null,
    "consent": true,
    "campaign_id": "cmgx1a2b3c0011",
    "submitted_at": "2026-10-19T12:10:00.000Z"
  }
}
  • counted is false for an answer EzReach did not count (the event closed, the slot was full, or the form was not EzReach's own). problem says why.
  • name is what the person typed. consent is their answer to the form's consent box.

Campaigns

campaign.completed

A WhatsApp or email campaign finished sending. `channel` says which.

WhatsApp campaign
{
  "id": "evt_131c9a0b2d3e4f5061728394",
  "type": "campaign.completed",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "campaign_id": "cmgx1a2b3c0011",
    "channel": "whatsapp",
    "name": "Diwali sale",
    "started_at": "2026-10-19T09:00:00.000Z",
    "completed_at": "2026-10-19T09:42:10.000Z",
    "whatsapp_number_id": "cmgx1a2b3c0004",
    "counts": {
      "recipients": 5000,
      "sent": 4950,
      "delivered": 4800,
      "read": 3100,
      "replied": 240,
      "failed": 50,
      "skipped": 0
    }
  }
}
Email campaign
{
  "id": "evt_141c9a0b2d3e4f5061728394",
  "type": "campaign.completed",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "campaign_id": "cmgx1a2b3c0031",
    "channel": "email",
    "name": "October newsletter",
    "started_at": "2026-10-19T09:00:00.000Z",
    "completed_at": "2026-10-19T09:20:00.000Z",
    "counts": {
      "recipients": 12000,
      "sent": 11900,
      "delivered": 11700,
      "bounced": 150,
      "complained": 3,
      "opened": 4200,
      "clicked": 610,
      "unsubscribed": 25,
      "failed": 10,
      "skipped": 90
    }
  }
}
  • The counts are those at the moment the campaign finished. Delivery receipts, reads, opens and clicks keep arriving afterwards: follow them with the other events or the REST API.

The test event

webhook.test is sent only when you choose Send test event. You cannot subscribe to it, and it is never retried. It is signed like every other event.

Request body
{
  "id": "evt_151c9a0b2d3e4f5061728394",
  "type": "webhook.test",
  "created_at": "2026-10-19T10:15:03.120Z",
  "data": {
    "message": "This is a test event from EzReach. If you can read it and the signature checks out, your endpoint is ready.",
    "endpoint_id": "cmgx1a2b3c0050"
  }
}