Get a notification sent to an agent
/v1/whatsapp/numbers/{number_id}/agent/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(
"wan_01krdgeqcxet5s7t44vh8rt9mg",
"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(
"wan_01krdgeqcxet5s7t44vh8rt9mg",
"waan_01krdgeqcxet5s7t44vh8rt9m7",
)
print(notification.status, notification.skipped_reason or notification.error)notification, err := client.Whatsapp.Agents.Notifications.Get(context.Background(), "wan_01krdgeqcxet5s7t44vh8rt9mg", "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('wan_01krdgeqcxet5s7t44vh8rt9mg', 'waan_01krdgeqcxet5s7t44vh8rt9m7');
echo $notification->getStatus(), ' ', $notification->getSkippedReason() ?? $notification->getError()?->getDescription();bird whatsapp agents notifications get <number-id> <notification-id>curl -X GET "https://us1.platform.bird.com/v1/whatsapp/numbers/{number_id}/agent/notifications/{notification_id}" \
-H "Authorization: Bearer $TOKEN"{
"id": "waan_01krdgeqcxet5s7t44vh8rt9m7",
"to": {
"phone_number": "+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. A number without an agent, and an id the agent does not hold, both return 404.
Parameters
number_idstringID of the WhatsApp number (wan_ prefix), as returned by the number list.
notification_idstringID of the notification (waan_ prefix), as returned when it was sent.
Response Payload
idUnique identifier for the notification.
toThe contact the notification was about: the phone number or business-scoped user ID you addressed it to, in the same shape a message's to uses.
Show child attributes
to.phone_numberPhone number in E.164 format, when known.
to.bsuidBusiness-scoped user ID, Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
to.group_idThe group this address was addressed as, or reached through. It appears on a message's to and nowhere else: never on from, and never on an event's recipient. Outbound, it stands in for the recipient, because a group send names no single phone number. Inbound, it qualifies one: to carries the business phone_number that received the message and the group it arrived through, while from stays the participant who wrote it. Its presence on to is what tells a group message from a one-to-one one, in either direction.
to.usernamePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the contact has not adopted one, and on a message received before this workspace started recording them. Same form as a number's own username (WhatsAppNumberProfile.username), without a leading @; a message cannot be addressed by it.
to.display_namePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the message carries no profile, and on a message received before this workspace started recording them.
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.
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.
Show child attributes
error.descriptionWhatsApp's own explanation, passed through: what it said when it refused the notification, or its failure summary once it had worked on it. Show it to the person who sent the notification; never match on its text. Carries Bird's own words instead when the failure was Bird's verdict, such as no outcome arriving within a day.
error.meta_error_codeWhatsApp's most specific code when it refused the notification outright: its error subcode where it sent one, otherwise its top-level code. Treat it as an opaque string. Null when WhatsApp took the notification and reported the failure later, which carries no code, and when the failure was Bird's own verdict.
created_atWhen Bird accepted the notification.
Related resources
Continue with the documentation, guides and examples for this topic.