Sign inGet Started

Get a notification sent to an agent

GET
/v1/whatsapp/agents/notifications/{notification_id}
// A notification still on its way to WhatsApp is not readable yet, so a read
// straight after create can throw a not-found error.
const notification = await bird.whatsapp.agents.notifications.get("waan_01krdgeqcxet5s7t44vh8rt9m7");
console.log(notification.status, notification.skipped_reason ?? notification.error?.description);
Réponse200
{
  "id": "waan_01krdgeqcxet5s7t44vh8rt9m7",
  "from": "+13124495648",
  "to": "+14155551234",
  "name": "order_shipped",
  "description": "Order 88213 left the warehouse and arrives on Thursday.",
  "payload": "{\"order_id\":\"88213\",\"carrier\":\"ACME Courier\",\"eta\":\"2026-10-02\"}",
  "status": "skipped",
  "skipped_reason": "The contact's conversation is currently held by the business.",
  "created_at": "2026-10-01T08:00:00Z"
}

Returns one notification you sent the agent, with what came of it: accepted while WhatsApp is still working on it, then success, skipped with WhatsApp's reason, or failed with what went wrong. A notification still in flight to WhatsApp is not readable yet, and an id this workspace does not hold returns 404. A notification stays readable after its agent is deleted.

Paramètres

notification_idstring

ID of the notification (waan_ prefix), as returned when it was sent.

Contenu de la réponse

id
string
obligatoire

Unique identifier for the notification.

from
string
obligatoire

The business number whose agent the notification was sent to, in E.164 format.

to
string
obligatoire

The contact the notification was about, as you addressed it: a phone number in E.164 format, or a business-scoped user ID.

name
string
obligatoire

Your own name for what happened, as you sent it.

description
string
obligatoire

What happened, as you sent it.

payload
string
obligatoire

The data you attached, as you sent it.

status
string
obligatoire

Where the notification stands. accepted from the moment Bird takes it, then one of the three final states once WhatsApp has answered.

skipped_reason
string

WhatsApp's own account of why the agent chose to say nothing, passed through. Present only when status is skipped. Show it to the person who sent the notification; never match on its text.

error
object

Why the notification failed. Present only when status is failed.

Afficher les attributs enfants
created_at
string
obligatoire

When Bird accepted the notification.

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