Skip to main content
GET
List WhatsApp events

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Scopes

whatsapp:read

Query Parameters

type
enum<string>

Filters events by type. Type of a WhatsApp event. Each type belongs to one webhook group. Wavix can add event types to a group, so ignore an event whose type you don't recognize. Possible values:

  • whatsapp.message.received — One of your senders received a message.
  • whatsapp.message.sent — A message you sent has the sent status: it isn't delivered yet.
  • whatsapp.message.delivered — A message you sent was delivered to the recipient. WhatsApp can skip it when the recipient reads the message right away.
  • whatsapp.message.read — The recipient opened a message you sent. WhatsApp reports it only when the recipient has read receipts turned on.
  • whatsapp.message.failed — A message you sent wasn't delivered. data.error says why.
  • whatsapp.contact.marketing_stopped — A contact asked to stop marketing messages from one of your senders. Meta doesn't deliver marketing templates to the contact until they resume them.
  • whatsapp.contact.marketing_resumed — A contact asked to receive marketing messages from one of your senders again.
  • whatsapp.template.approved — The provider approved one of your templates, so you can send it.
  • whatsapp.template.rejected — The provider rejected one of your templates.
  • whatsapp.template.paused — The provider paused one of your templates.
  • whatsapp.template.disabled — One of your templates is disabled and can't be sent.
  • whatsapp.template.flagged — Meta flagged one of your templates because of negative feedback. It can still be sent, but it's at risk of being paused or disabled.
  • whatsapp.template.category_changed — Meta moved one of your templates to another category, which changes the rate of each message sent with it.
  • whatsapp.template.quality_changed — Meta changed the quality rating of one of your templates.
  • whatsapp.template.updated — The status of one of your templates changed to a value that has no event type of its own, such as pending, in_appeal, or deleted.
  • whatsapp.sender.connected — One of your senders can send messages within its messaging limit, for example after registration or when a restriction ends.
  • whatsapp.sender.restricted — One of your senders reached its messaging limit. It can't start new conversations until the 24-hour window resets, but it can still reply to customers who messaged it.
  • whatsapp.sender.flagged — The quality rating of one of your senders dropped to low. The status returns to connected if the rating returns to medium or high within 7 days.
  • whatsapp.sender.banned — The provider banned one of your senders.
  • whatsapp.sender.disconnected — One of your senders is disconnected from the provider.
  • whatsapp.sender.quality_changed — Meta changed the quality rating of one of your senders.
  • whatsapp.sender.updated — The status of one of your senders changed to a value that has no event type of its own, such as pending, migrated, or deleted.
Available options:
whatsapp.message.received,
whatsapp.message.sent,
whatsapp.message.delivered,
whatsapp.message.read,
whatsapp.message.failed,
whatsapp.contact.marketing_stopped,
whatsapp.contact.marketing_resumed,
whatsapp.template.approved,
whatsapp.template.rejected,
whatsapp.template.paused,
whatsapp.template.disabled,
whatsapp.template.flagged,
whatsapp.template.category_changed,
whatsapp.template.quality_changed,
whatsapp.template.updated,
whatsapp.sender.connected,
whatsapp.sender.restricted,
whatsapp.sender.flagged,
whatsapp.sender.banned,
whatsapp.sender.disconnected,
whatsapp.sender.quality_changed,
whatsapp.sender.updated
Example:

"whatsapp.message.received"

group
enum<string>

Filters events by the webhook group their type belongs to. Group of WhatsApp event types that a webhook receives. Your account can have one webhook per group. Possible values:

  • messages — Messages your senders receive, the delivery outcome of messages you send, and contacts' marketing preferences.
  • templates — Changes to the status, category, and quality rating of your templates.
  • senders — Changes to the status and quality rating of your senders.
Available options:
messages,
templates,
senders
Example:

"messages"

after
string

Returns only events recorded after the event with this ID. Pass next_cursor from the previous page. Without it, the list starts at the oldest event kept.

Pattern: ^evt_[0-9a-f]{32}$
limit
integer<int32>
default:25

Maximum number of events to return. Defaults to 25.

Required range: 1 <= x <= 100

Response

A paginated list of WhatsApp events, oldest first.

A paginated list of your account's WhatsApp events, returned by List WhatsApp events.

events
WhatsAppEvent · object[]
required

Events in the order Wavix recorded them, oldest first. Empty when no event matches.

next_cursor
string | null
required

ID of the last event on this page. Pass it as after to get the events that follow. Null when the page is empty; keep the cursor you have, or omit after if you have none.

Example:

"evt_1b3d5f7a9c2e4b6d8f0a1c3e5b7d9f2a"

has_more
boolean
required

true when more events follow this page right now. false means you've caught up; events recorded later appear after the same cursor.

Example:

false