Test a webhook with a sample event

Workspace that owns this message.

Message state when the event occurred. Later state changes do not alter this snapshot. Customer metadata is included when present; reserved Bird metadata is excluded.

Workspace that owns this conversation.

Business that owns this conversation.

Conversation that changed state.

Number of times the conversation has opened, starting at 1 and increasing on each reopen. Together with the conversation ID and event type, this identifies the lifecycle occurrence across retries.

Source of the lifecycle change, when recorded.

Apple entry-point group recorded for this occurrence, when present.

Apple entry-point intent recorded for this occurrence, when present.

Routing queue recorded for this occurrence, when present.

Workspace that owns this conversation.

Business that owns this conversation.

Conversation that changed state.

Number of times the conversation has opened, starting at 1 and increasing on each reopen. Together with the conversation ID and event type, this identifies the lifecycle occurrence across retries.

Source of the lifecycle change, when recorded.

Apple entry-point group recorded for this occurrence, when present.

Apple entry-point intent recorded for this occurrence, when present.

Routing queue recorded for this occurrence, when present.

Workspace that owns this conversation.

Business that owns this conversation.

Conversation that changed state.

Number of times the conversation has opened, starting at 1 and increasing on each reopen. Together with the conversation ID and event type, this identifies the lifecycle occurrence across retries.

Source of the lifecycle change, when recorded.

Apple entry-point group recorded for this occurrence, when present.

Apple entry-point intent recorded for this occurrence, when present.

Routing queue recorded for this occurrence, when present.

Workspace that owns this message.

Message state when the event occurred. Later state changes do not alter this snapshot. Customer metadata is included when present; reserved Bird metadata is excluded.

Workspace that owns this message.

Message state when the event occurred. Later state changes do not alter this snapshot. Customer metadata is included when present; reserved Bird metadata is excluded.

Workspace that owns this message.

Message state when the event occurred. Later state changes do not alter this snapshot. Customer metadata is included when present; reserved Bird metadata is excluded.

Workspace that owns this message.

Message state when the event occurred. Later state changes do not alter this snapshot. Customer metadata is included when present; reserved Bird metadata is excluded.

The suppression episode that was opened.

The business account this suppression covers, or null when it covers the workspace.

The canonical phone number or exact opaque Apple identifier that was suppressed.

What kind of value address holds.

• phone_number means address is the customer's phone number. Apple's CloseSession event carries a phone number rather than an opaque identifier, so a suppression opened by a close on a conversation identified by phone number takes this kind.
• opaque_user_id means address is the opaque identifier Apple assigns to the customer's conversation with the business, stable across a close and a later re-initiation.

Possible values: phone_number, opaque_user_id

Why the handle is suppressed. manual means it was added directly through this API or the dashboard. opted_out covers every case where Apple or the customer signaled they should not be contacted: a close, a permanent delivery failure, a declined invitation, or a stop keyword. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

Possible values (may grow over time): manual, opted_out

Who created the episode. user and api_key identify manual blocks. close_session and gone are protected automatic conversation facts. Phone invitation opt-outs are recorded as preferences.

Possible values (may grow over time): user, api_key, close_session, gone

The workspace the suppression belongs to.

The sending domain resource whose verification failed.

The sending domain hostname.

The workspace the domain is assigned to.

Why verification failed, when a specific reason is available (for example, the DKIM record was not found at the expected selector).

The sending domain resource that verified.

The sending domain hostname.

The workspace the domain is assigned to.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

Bounce classification.

• hard: A permanent failure, such as an invalid address or a domain that does not exist.
• soft: A transient failure, such as a full mailbox or a server that is temporarily unavailable.
• block: The receiving mail server refused the sending IP on reputation grounds.
• admin: An administrative refusal, such as relaying denied or a blocklisted domain.
• undetermined: The receiving server's response was ambiguous.

Possible values: hard, soft, undetermined, admin, block

Numeric bounce classification for fine-grained deliverability triage, or null when the receiving server's response could not be classified. Lets you distinguish, for example, a DNS failure from a spam block when both would be bounce_type: soft or bounce_type: block.

SMTP reply code returned by the receiving mail server, or null when none was provided.

Human-readable reason the receiving mail server gave for the bounce, or null when none was provided.

The IP address used to send this message, or null when it is not known.

ID of the email send.

ID of the workspace that owns this event.

Tags provided on the send request, echoed on the event so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on the event so you can correlate events with your own records. Null when the send carried no metadata.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

The URL the recipient clicked.

IP address of the client that clicked the link, or null when it is not known.

User-agent string of the client that clicked the link, or null when it is not known.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

The kind of feedback the mailbox provider reported (such as abuse or fraud), or null when the provider did not specify one.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

Bounce classification.

• hard: A permanent failure, such as an invalid address or a domain that does not exist.
• soft: A transient failure, such as a full mailbox or a server that is temporarily unavailable.
• block: The receiving mail server refused the sending IP on reputation grounds.
• admin: An administrative refusal, such as relaying denied or a blocklisted domain.
• undetermined: The receiving server's response was ambiguous.

Possible values: hard, soft, undetermined, admin, block

Numeric bounce classification for fine-grained deliverability triage, or null when the receiving server's response could not be classified. Distinguishes, for example, a greylisting deferral from a full mailbox.

Human-readable reason the receiving mail server gave for the deferral, or null when none was provided.

The IP address used to send this message, or null when it is not known.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

IP address of the client that opened the email, or null when it is not known.

User-agent string of the client that opened the email, or null when it is not known.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

Bounce classification.

• hard: A permanent failure, such as an invalid address or a domain that does not exist.
• soft: A transient failure, such as a full mailbox or a server that is temporarily unavailable.
• block: The receiving mail server refused the sending IP on reputation grounds.
• admin: An administrative refusal, such as relaying denied or a blocklisted domain.
• undetermined: The receiving server's response was ambiguous.

Possible values: hard, soft, undetermined, admin, block

Numeric bounce classification for fine-grained deliverability triage, or null when the receiving server's response could not be classified.

SMTP reply code returned by the receiving mail server, or null when none was provided.

Human-readable reason the receiving mail server gave for the bounce, or null when none was provided.

The IP address used to send this message, or null when it is not known.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

ID of the received email. Fetch its parsed metadata with GET /v1/email/inbound-messages/{id}, and its content from that message's /body, /raw, and /attachments sub-resources.

ID of the workspace that owns this event.

RFC 5322 Message-ID header from the sender, or null when the sender did not include one.

Address from the message's From header, with the relay's parsed sender and then the SMTP envelope sender as fallbacks when that header cannot be read. This field alone does not authenticate the sender.

Parsed recipient addresses from the message headers, not the envelope recipient used to route this delivery.

Subject line as received, or null when the message had no subject.

In-Reply-To header containing the Message-ID this message replies to, or null when it is not a reply.

DMARC result for the domain in the received message's From header.

• pass: SPF or DKIM passed and aligned with that domain.
• fail: DMARC was evaluated and did not pass.
• unknown: no trustworthy verdict is available.

This follows dmarc_pass and does not verify a particular person. The receiving provider currently supplies no DMARC result, so received messages report unknown.

Possible values: pass, fail, unknown, null

Whether the receiving provider reports that SPF authorized the envelope sender for the sending server. A soft failure is false. Missing, neutral and inconclusive results are null.

Whether the receiving provider verified a DKIM signature. A passing signature makes this true even when another signature fails. Missing signatures and inconclusive verification results are null.

Whether SPF or DKIM passed and aligned with the domain in the message's From header. The receiving provider currently supplies no DMARC result, so this is null.

Content spam score when available. The receiving provider currently supplies no score, so this is null.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

Why an email was rejected before delivery.

• recipient_suppressed: The recipient is on the workspace suppression list, so delivery was never attempted.
• transmission_failed: The message could not be transmitted for delivery.
• generation_failure: The message could not be built for delivery (template or content issue).
• policy_rejection: The message was refused by sending policy.
• domain_unverified: The sending domain was not verified.
• quota_exceeded: The organization's send quota was reached.
• recipient_not_allowed: A recipient was not permitted for this send (for shared onboarding-domain sends, recipients must be verified workspace members).

Possible values: recipient_suppressed, transmission_failed, generation_failure, policy_rejection, domain_unverified, quota_exceeded, recipient_not_allowed

ID of the email send.

ID of the workspace that owns this event.

Tags provided on the send request, echoed on the event so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on the event so you can correlate events with your own records. Null when the send carried no metadata.

When the message is scheduled to send.

ID of the email send.

ID of the recipient.

ID of the workspace that owns this event.

Recipient address as it appeared on the envelope.

Envelope position of the recipient.

Possible values: to, cc, bcc

Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.

The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.

The broadcast this send went out as part of, echoed on every per-recipient event for the send so you can attribute engagement to the broadcast without an extra lookup. Null when the send was not part of a broadcast. On email.unsubscribed and email.list_unsubscribed, null can also mean the recipient used an unsubscribe link that names no broadcast, so on those two events null does not rule a broadcast out.

ID of the delivered message. Per-recipient email.* events use this value as email_id. Use it to deduplicate events when you subscribe to both event families.

ID of the mailbox the message was sent from.

ID of the thread the message belongs to.

ID of the failed message. Per-recipient email.* events use this value as email_id. Use it to deduplicate events when you subscribe to both event families.

ID of the mailbox the message was sent from.

ID of the thread the message belongs to.

Why the message reached a terminal delivery failure.

ID of the received message. The corresponding email.received event uses this value as inbound_message_id. Use it to deduplicate events when you subscribe to both event families.

ID of the mailbox that received the message.

ID of the thread the message was filed into.

ID (ein_…) of the explicit inbound route that matched, or null when the message was delivered by the virtual exact-address route.

Envelope-from address.

Recipient addresses the message was sent to.

Subject line as received, or null when the message had no subject.

Plain-text body with quoted history removed, capped at 64 KB. See truncated_text to check whether the value was truncated. Null when extraction produces no text.

True when extracted_text was truncated to the 64 KB cap. Fetch the full text through the thread-member endpoint.

Number of attachments on the message. Attachment content remains available for the mailbox's retention tier.

DMARC result for the domain in the received message's From header.

• pass: SPF or DKIM passed and aligned with that domain.
• fail: DMARC was evaluated and did not pass.
• unknown: no trustworthy verdict is available.

This follows dmarc_pass and does not verify a particular person. The receiving provider currently supplies no DMARC result, so received messages report unknown.

Possible values: pass, fail, unknown, null

Whether the receiving provider reports that SPF authorized the envelope sender for the sending server. A soft failure is false. Missing, neutral and inconclusive results are null.

Whether the receiving provider verified a DKIM signature. A passing signature makes this true even when another signature fails. Missing signatures and inconclusive verification results are null.

Whether SPF or DKIM passed and aligned with the domain in the message's From header. The receiving provider currently supplies no DMARC result, so this is null.

ID of the sent message. Per-recipient email.* events use this value as email_id. Use it to deduplicate events when you subscribe to both event families.

ID of the mailbox the message was sent from.

ID of the thread the message belongs to.

ID of the suspended mailbox.

Why the mailbox was suspended.

ID of the thread.

ID of the mailbox the thread was created in.

Subject of the first message in the thread, or null when it had none.

Which direction created the thread.

Possible values: inbound, outbound

The suppression entry that was created.

The recipient address that was added to the suppression list.

Why the address was suppressed. New values may be added over time; treat unknown values as informational.

Possible values (may grow over time): hard_bounce, complaint, unsubscribe, manual

The workspace the suppression belongs to.

The preference key this write applied to.

The ledger entry this write appended.

Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS, WhatsApp, and Apple Messages for Business.

The sender the statement is limited to, or null when it covers the whole channel. On Apple Messages for Business, this is the Apple business ID used to send invitations. Present-with-null on every payload of this type: it is part of the key alongside topic_id, and pinning its presence keeps a subscriber from ever learning (handle, channel) as the unique key.

The topic the statement is limited to, or null when it covers every topic. Reserved: always null in v1. Present-with-null for the same reason as sender_scope.

The contact whose handle matched when the statement was recorded. Null when no contact matched at that moment.

The preference key this write applied to.

The ledger entry this write appended.

Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS, WhatsApp, and Apple Messages for Business.

The sender the statement is limited to, or null when it covers the whole channel. On Apple Messages for Business, this is the Apple business ID used to send invitations. Present-with-null on every payload of this type: it is part of the key alongside topic_id, and pinning its presence keeps a subscriber from ever learning (handle, channel) as the unique key.

The topic the statement is limited to, or null when it covers every topic. Reserved: always null in v1. Present-with-null for the same reason as sender_scope.

The contact whose handle matched when the statement was recorded. Null when no contact matched at that moment.

The preference key this write applied to.

The ledger entry this write appended.

Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS, WhatsApp, and Apple Messages for Business.

The sender the statement is limited to, or null when it covers the whole channel. On Apple Messages for Business, this is the Apple business ID used to send invitations. Present-with-null on every payload of this type: it is part of the key alongside topic_id, and pinning its presence keeps a subscriber from ever learning (handle, channel) as the unique key.

The topic the statement is limited to, or null when it covers every topic. Reserved: always null in v1. Present-with-null for the same reason as sender_scope.

The contact whose handle matched when the statement was recorded. Null when no contact matched at that moment.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Segment breakdown used to calculate the message charge.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Carrier that delivered the message. Absent when the carrier does not report one.

Mobile country code and mobile network code of the carrier. Absent when the carrier does not report one.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Why the message was still undelivered when its validity period elapsed. Typically unreachable, the handset having stayed off or out of coverage for the whole window.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Why the message terminally failed.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Why the message was rejected before reaching the carrier.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Carrier that handled the message. Absent when the carrier does not report one.

Mobile country code and mobile network code of the carrier. Absent when the carrier does not report one.

ID of the SMS message.

ID of the workspace that owns this event.

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.

Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.

The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

The template language rendered at acceptance, in canonical form. Null when the send used no template.

The template rendered at acceptance, or null for a free-text message.

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

The rendered language's source fingerprint, or null for a free-text message.

Message cost as of this event, split into the platform charge and any third-party fees passed through. Null on an event that priced nothing.

Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest occurred_at you have seen for each component. amount is the sum of the components in this payload and does not represent a settled total.

Why the message was not delivered.

The suppression episode that was opened.

The subscriber, in E.164 format.

The sender this stops. An SMS suppression is the exact (sender, recipient) pair, so your other senders still reach this subscriber.

The workspace the suppression belongs to.

ID of the verification session.

ID of the workspace that owns this event.

The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own address field.

The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.

The channel this attempt was sent on.

Possible values (may grow over time): email, sms, whatsapp, telegram, voice

The single address this attempt was dispatched to, an E.164 phone number or an email address.

Carrier that delivered the message, when the carrier network reports it. Always null for email, WhatsApp, and Telegram.

Mobile country code and mobile network code of the delivering carrier, when reported. Always null for email, WhatsApp, and Telegram.

Time delivery was confirmed.

ID of the verification session.

ID of the workspace that owns this event.

The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own address field.

The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.

The channel this attempt was sent on.

Possible values (may grow over time): email, sms, whatsapp, telegram, voice

The single address this attempt was dispatched to, an E.164 phone number or an email address.

The sender the passcode was sent from: a phone number, alphanumeric sender ID, short code, or email address. Null when the channel exposes no sender.

Time the passcode was dispatched.

ID of the verification session.

ID of the workspace that owns this event.

The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own address field.

The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.

The channel this attempt was sent on.

Possible values (may grow over time): email, sms, whatsapp, telegram, voice

The single address this attempt was dispatched to, an E.164 phone number or an email address.

Why the attempt failed to reach the recipient.

Possible values (may grow over time): carrier_rejected, hard_bounce, soft_bounce, undelivered, channel_unavailable, channel_disabled, channel_restricted, delivery_timeout, not_billable

Diagnostic text describing the failure, for display only. Null when none was reported.

Time the failure was recorded.

ID of the verification session.

ID of the workspace that owns this event.

The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own address field.

The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.

The first channel of the verification's resolved channel plan.

Possible values (may grow over time): email, sms, whatsapp, telegram, voice

The verification's state at creation, always pending. Open enum for forward compatibility.

Possible values (may grow over time): pending

Time the verification session was created.

ID of the verification session.

ID of the workspace that owns this event.

The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own address field.

The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.

The verification's state, always failed. Open enum for forward compatibility.

Possible values (may grow over time): failed

Why the verification ended. Always undeliverable on this event: no planned channel delivered a passcode.

Possible values (may grow over time): attempts_exhausted, ttl_elapsed, undeliverable

The last channel the verification tried, the one whose failure left it with nowhere else to go. Null when no channel was attributed.

Why that last send did not deliver. This is the actionable half of the event: not_billable means the workspace balance could not cover the send, while the delivery reasons point at the recipient or the channel.

Possible values (may grow over time): carrier_rejected, hard_bounce, soft_bounce, undelivered, channel_unavailable, channel_disabled, channel_restricted, delivery_timeout, not_billable

Time the verification was resolved.

ID of the verification session.

ID of the workspace that owns this event.

The recipient identity of the verification session (email address, phone number, or both), echoed on every event so you can correlate without an extra lookup. An individual attempt reports the single address it was dispatched to in its own address field.

The metadata object provided when the verification was created, echoed on every event for the session so you can correlate events with your own records. Null when the verification carried no metadata.

The verification's state, always verified. Open enum for forward compatibility.

Possible values (may grow over time): verified

The channel whose passcode the recipient confirmed, the channel that converted. Null when the verification was resolved without attributing a channel.

Time the verification was verified.

ID of the call record.

Session identifier shared across all legs of a multi-party or transferred call. Use this to correlate related call records. Null when session correlation is not available for the call.

ID of the workspace that owns this event.

Whether the call was placed from your side, by your PBX, the API, the browser or Bird dialing onward for you (outbound), or arrived from a remote party (inbound).

Possible values: inbound, outbound

Calling party number in E.164 format.

Called party number in E.164 format.

ID of the call record.

Session identifier shared across all legs of a multi-party or transferred call. Use this to correlate related call records. Null when session correlation is not available for the call.

ID of the workspace that owns this event.

Whether the call was placed from your side, by your PBX, the API, the browser or Bird dialing onward for you (outbound), or arrived from a remote party (inbound).

Possible values: inbound, outbound

Calling party number in E.164 format.

Called party number in E.164 format.

Call status.

A call that has ended carries one of:

• answered means it connected and the far end picked up.
• no_answer means nobody picked up before the call timed out.
• rejected means it was refused rather than attempted. Either we turned it away before dialing a carrier, in which case rejection_reason names the check it failed where there was one, or the far end declined it.
• failed means it was attempted and did not work, and sip_response_code is what came back.
• unknown means the outcome could not be determined. Contact support with the call id if you see one.

An active call carries ringing before it is picked up and in_progress afterward. The call list's status filter takes any mix of the two sets.

busy and canceled are reserved for incoming calls delivered to your own numbers: busy for a called party that rejected the call as busy, canceled for a caller who hung up before it was picked up. Neither is emitted yet and both outcomes are reported as failed today.

Possible values: answered, no_answer, busy, canceled, failed, rejected, unknown, ringing, in_progress

Final SIP response code received from the carrier. Null when no SIP response was received, for example on timeout or DNS failure.

Total call duration in milliseconds, measured from the first SIP INVITE to the BYE or final response.

Billable duration in milliseconds, measured from answer to call end. Zero for unanswered calls.

ID of the call record.

Session identifier shared across all legs of a multi-party or transferred call. Use this to correlate related call records. Null when session correlation is not available for the call.

ID of the workspace that owns this event.

Whether the call was placed from your side, by your PBX, the API, the browser or Bird dialing onward for you (outbound), or arrived from a remote party (inbound).

Possible values: inbound, outbound

Calling party number in E.164 format.

Called party number in E.164 format.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

The participant delivery was confirmed to, on a group message. A group send raises this event once per participant, so this is what tells the deliveries apart. Absent on a one-to-one message, whose to already names its recipient.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

Why the message terminally failed.

The group the person asked to join.

The business number that created the group and administers it.

The workspace that owns the group.

The request itself, and who made it.

The group the person asked to join.

The business number that created the group and administers it.

The workspace that owns the group.

The request itself, and who made it.

The message the contact reacted to. WhatsApp accepts a reaction on a message up to 30 days old, and we keep provider ids for 15, so a reaction placed on a message older than that cannot be matched to it and raises no event at all.

The emoji the contact placed, as WhatsApp sent it and not normalized. Null when they took their reaction back rather than placing one. Always present, so null is the removal itself rather than a value we are missing.

The contact who reacted, as WhatsApp identified them.

Your WhatsApp number, the business side of the conversation.

ID of the workspace that owns this event.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

The participant who opened the message, on a group message. A group send raises this event once per participant, so this is what tells the deliveries apart. Absent on a one-to-one message, whose to already names its recipient.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

Text the contact sent.

Image the contact sent.

Video the contact sent.

Audio the contact sent.

Sticker the contact sent.

Document the contact sent.

Location the contact sent.

Contact cards the contact shared, either by tapping a button that asked for their number or by sending a card from their address book.

What the contact tapped, when the message answers an interactive message or a template's quick-reply button.

Set when the contact sent content the API does not model, naming the WhatsApp content type.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

Why the message was rejected before sending.

ID of the WhatsApp message.

ID of the workspace that owns this event.

Whether the message was sent by the business (outbound) or received from the contact (inbound).

Possible values: outbound, inbound

Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.

Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.

Tags from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no tags.

The metadata object from the send request, echoed on every event for the message. Null when the message was not sent through Bird, or its request carried no metadata.

The message this one answers. On an outbound message it is the message it quoted: for a send request, its in_reply_to_message_id. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.

Where the message came from when it did not come through Bird live, the same value GET /v1/whatsapp/messages/{message_id} returns. Absent when your workspace sent the message through Bird, or the contact sent it to Bird.

The suppression episode that was opened.

The suppressed WhatsApp address. For a phone number this is canonical E.164 with a leading plus sign, such as +5511977670804.

The WhatsApp Business Account the suppression is limited to, identified by its WhatsApp-issued account ID, or null when it covers the whole workspace.

Why the address is suppressed. manual means it was added directly rather than created automatically from a delivery outcome. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

Possible values (may grow over time): manual

The workspace the suppression belongs to.