Skip to content

Event Catalog

Available events

Event	Fires when
`message.received`	An inbound message arrives from a customer
`message.sent`	An outbound message is accepted by WhatsApp
`message.delivered`	An outbound message is delivered to the device
`message.read`	The customer reads your outbound message
`message.failed`	Message delivery permanently fails
`conversation.created`	A new conversation is started (first message)
`conversation.status_changed`	A conversation is opened, closed, or gets a new status label
`contact.created`	A new contact is added to your workspace
`contact.updated`	A contact’s name, email, or tags are updated
`broadcast.completed`	A broadcast send finishes (all messages dispatched)

Sample payloads

`message.received`

{
  "message": {
    "id": "msg_123",
    "conversationId": "conv_abc",
    "contactId": "contact_xyz",
    "direction": "inbound",
    "type": "text",
    "content": { "text": "Hello, I need help!" },
    "status": "delivered",
    "waMessageId": "wamid.abcdef",
    "timestamp": "2026-06-01T10:00:00.000Z"
  },
  "contact": { "id": "contact_xyz", "name": "Jane Doe", "phoneNumber": "+1234567890" },
  "conversation": { "id": "conv_abc", "status": "open", "channel": "whatsapp" }
}

`contact.created`

{
  "contact": {
    "id": "contact_xyz",
    "phoneNumber": "+1234567890",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "tags": ["vip"],
    "createdAt": "2026-06-01T10:00:00.000Z"
  }
}

`message.delivered` / `message.read` / `message.failed`

{
  "waMessageId": "wamid.abcdef",
  "status": "delivered",
  "errorMessage": null
}