Get a notification sent to an agent
/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);# A notification still on its way to WhatsApp is not readable yet, so a read
# straight after create can raise a not-found error.
notification = client.whatsapp.agents.notifications.get("waan_01krdgeqcxet5s7t44vh8rt9m7")
print(notification.status, notification.skipped_reason or notification.error)notification, err := client.Whatsapp.Agents.Notifications.Get(context.Background(), "waan_01krdgeqcxet5s7t44vh8rt9m7")
if err != nil {
log.Fatal(err)
}
if notification.SkippedReason != nil {
fmt.Println(*notification.Status, *notification.SkippedReason)
} else if notification.Error != nil {
fmt.Println(*notification.Status, *notification.Error.Description)
} else {
fmt.Println(*notification.Status)
}// A notification still on its way to WhatsApp is not readable yet, so a read
// straight after create can throw a not-found ApiException.
$notification = $bird->whatsapp->agents->notifications->get('waan_01krdgeqcxet5s7t44vh8rt9m7');
echo $notification->getStatus(), ' ', $notification->getSkippedReason() ?? $notification->getError()?->getDescription();bird whatsapp agents notifications get <notification-id>curl -X GET "https://us1.platform.bird.com/v1/whatsapp/agents/notifications/{notification_id}" \
-H "Authorization: Bearer $TOKEN"{
"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.
Parâmetros
notification_idstringID of the notification (waan_ prefix), as returned when it was sent.
Payload de resposta
idUnique identifier for the notification.
fromThe business number whose agent the notification was sent to, in E.164 format.
toThe contact the notification was about, as you addressed it: a phone number in E.164 format, or a business-scoped user ID.
nameYour own name for what happened, as you sent it.
descriptionWhat happened, as you sent it.
payloadThe data you attached, as you sent it.
statusWhere the notification stands. accepted from the moment Bird takes it, then one of the three final states once WhatsApp has answered.
Possible values: accepted, success, skipped, failed
skipped_reasonWhatsApp'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.
errorWhy the notification failed. Present only when status is failed.
created_atWhen Bird accepted the notification.
Recursos relacionados
Continue com a documentação, guias e exemplos sobre este tópico.