Sign inGet Started

List WhatsApp template events

GET
/v1/whatsapp/templates/{template_ref}/events
for await (const event of bird.whatsapp.templates.listEvents("order_update", { language: "en-US" })) {
  console.log(event.created_at, event.type, event.summary);
}
Respuesta200
{
  "data": [
    {
      "id": "wte_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "whatsapp_template.status_changed",
      "language": "en-US",
      "version_id": "wav_01krdgeqcxet5s7t44vh8rt9mg",
      "summary": "Status changed to paused.",
      "metadata": {
        "from": "approved",
        "to": "paused"
      },
      "created_at": "2026-11-18T14:02:11Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the template's history since Bird began recording it, newest first:

  • A status WhatsApp gave one of its languages, such as an approval, a rejection, a pause, a reinstatement, or a deletion.
  • A change in a language's quality rating.

Use it to see when a language was paused or its quality dropped, rather than polling Get a WhatsApp template. Changes Bird makes, such as submitting a language for review or deleting it at your request, are not listed. A Bird-managed template has no history and returns an empty page. A template that does not belong to the workspace, or no longer exists, returns 404.

Parámetros

template_refstring

Template ID (wat_ prefix) or slug. A value that parses as a valid ID resolves by ID; any other value resolves as a slug.

Parámetros de consulta

languagestring

Return only this language's events. A BCP-47 tag; case and separator differences are accepted and normalized.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Carga de respuesta

data
array of object
obligatorio

Page of template events, newest first.

Mostrar atributos secundarios
data.id
string
obligatorio

Event ID.

data.type
string
obligatorio

Type of template event. whatsapp_template.status_changed records a status WhatsApp gave the language. whatsapp_template.quality_updated records a change in its quality rating. Open enum: new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.

Possible values (may grow over time): whatsapp_template.status_changed, whatsapp_template.quality_updated

data.language
string
obligatorio

Language the event concerns, as a BCP-47 tag.

data.version_id
string
obligatorio

Version whose language changed. A pause or a quality change applies to the version that is sending, when one exists, which is not always the newest one.

data.summary
string
obligatorio

Human-readable summary of what changed.

data.metadata
object
obligatorio

Structured details for the event. from and to carry the values that changed: a language status for whatsapp_template.status_changed, or a quality score for whatsapp_template.quality_updated. from is the value Bird held before the change, and is absent when Bird held none. A change to rejected also carries the rejection, in the same shape as the language, when WhatsApp gave a reason. A new pause on a language that was already paused has the same from and to.

data.created_at
string
obligatorio

When Bird recorded the event.

next_cursor
nullable string
obligatorio

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
obligatorio

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
obligatorio

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.