amb-messages

List events for a message

Returns a message's lifecycle events in chronological order, one entry per status transition (amb.accepted, amb.sent, amb.send_failed, amb.received). The timeline is bounded and returned in full, so this list is not paginated. Event history does not expire based on age.

get/v1/amb/messages/{message_id}/events

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/messages/{message_id}/events
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

typestring

Message timeline event type:

  • amb.accepted: The API accepted the request.
  • amb.sent: The message was handed to Apple.
  • amb.send_failed: Apple refused the message, or its send attempts were exhausted.
  • amb.rejected: Bird refused the message before any send attempt.
  • amb.received: An inbound message arrived from the customer.

This is an open enum. Accept unrecognized values.

Example:amb.sent

Keep only events of this exact type (for example amb.sent or amb.send_failed). Omit for the full timeline.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Event timeline for this message.

Example response

{
  "data": [
    {
      "id": "aev_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "amb.sent",
      "error": {
        "code": "bird:business_not_registered",
        "description": "Apple refused the message with HTTP status 404."
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.