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);
}
Réponse200
{
  "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.

Paramètres

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.

Paramètres de requête

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.

Contenu de la réponse

data
array of object
obligatoire

Page of template events, newest first.

Afficher les attributs enfants
next_cursor
nullable string
obligatoire

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

prev_cursor
nullable string
obligatoire

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

refresh_cursor
nullable string
obligatoire

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.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.