LogoLogo
No-code docsResources
  • 🖥️Welcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
    • Metrics
    • Events
    • Recipient Validation
    • SMTP API
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page

Was this helpful?

  1. Notifications API
  2. API Reference
  3. Webhook subscriptions

Webhook subscription logs

Last updated 6 months ago

Was this helpful?

Webhook logs regarding failures are available for our customers for seven days. You can check information such as how many attempts were executed, the request/response body, the final execution status and more. The following endpoints are available to interact with the logs.

Note: if you have more than 10 webhook logs, the results may be paginated. To know more about how to use the nextPageToken to get the following results, refer to this .

Examples

Let's establish some of our data that will be used in the following examples:

  • Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

  • Organization ID: 823fbfaf-f14e-4693-b55a-8ec1c17d649e

  • Webhook subscription ID: 0edf722b-93b4-4451-8a5d-4fafba5cdf8b

  • AccessKey: abcd

Retrieving logs for debugging

In this example, we retrieve all logs for a subscription. It will show information such as the request ID and how many attempts were executed to try to deliver the event succesfully. With that information, you can get more details, such as the request body and response and more. We show how to do that in our next example.

curl -X GET "https://api.bird.com/organizations/823fbfaf-f14e-4693-b55a-8ec1c17d649e/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/webhook-subscriptions/0edf722b-93b4-4451-8a5d-4fafba5cdf8b
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

{
  "nextPageToken": "WzE3MzI1NTk1MTk2ODYsIjk3ZDdmOGY2LTc3N2EtNGY3ZC04NTYxLWFmMDJiZjFjN2I2MSJd",
  "results": [
    {
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "subscriptionId": "0edf722b-93b4-4451-8a5d-4fafba5cdf8b",
      "requestId": "56878366-5417-414d-b1d9-5f250354f8d1",
      "attemptCount": 7,
      "httpStatusCode": 429,
      "executionStatus": "failed",
      "createdAt": "2024-11-26T10:05:07.083Z",
      "updatedAt": "2024-11-26T10:05:07.083Z"
    },
    {
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "subscriptionId": "0edf722b-93b4-4451-8a5d-4fafba5cdf8b",
      "requestId": "97d7f8f6-777a-4f7d-8561-af02bf1c7b61",
      "attemptCount": 36,
      "httpStatusCode": 429,
      "executionStatus": "failed",
      "createdAt": "2024-11-25T18:31:59.686Z",
      "updatedAt": "2024-11-25T18:31:59.686Z"
    }
  ]
}

Retrieving details about logged requests

Using the details route, you can get more information about the failures to deliver events. When querying a request ID (which can be found on the header of a request), you can obtain information about all delivery attempts. In the response example below, if there were 36 attempts, you would see 36 log details about each attempt.

curl -X GET "https://api.bird.com/organizations/823fbfaf-f14e-4693-b55a-8ec1c17d649e/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/webhook-subscriptions/0edf722b-93b4-4451-8a5d/logs/details?requestId=56878366-5417-414d-b1d9-5f250354f8d1" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {{token}}"

{
  "results": [
    {
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "subscriptionId": "0edf722b-93b4-4451-8a5d-4fafba5cdf8b",
      "requestId": "56878366-5417-414d-b1d9-5f250354f8d1",
      "attemptCount": 36,
      "httpStatusCode": 429,
      "executionStatus": "failed",
      "createdAt": "2024-11-25T18:32:46.962Z",
      "updatedAt": "2024-11-25T18:32:46.962Z",
      "payloadDetails": {
        "response": "<!DOCTYPE html>\n<html>\n<head>\n    <title>Error: Request limit exceeded. Sign up to unlock more requests.</title>\n    <link href=\"https://cdn.example.com/css/app.css\" rel=\"stylesheet\">\n</head>\n<body>\n<div class=\"container\" style=\"padding: 50px\">\n    <div class=\"row\">\n        <div class=\"col-sm-12 text-center\">\n            <h1><img src=\"https://cdn.webhook.site/icon.png\" alt=\"Logo\" style=\"width:40px; margin-top: -5px\">\X</h1>\n\n            <p class=\"lead\">Request limit exceeded. Sign up .</p>\n        </div>\n    </div>\n    <div class=\"row\">\n        <div class=\"col-sm-4 col-sm-offset-4 text-center\">\n                            <p>\n                        You have been rate limited due to too many requests to this URL.\n    This is either because you have not purchased\n, or the endpoint has a rate limit.<br>\n    <br>\n    To remove the request limit limit.\n    <br><br>\n    If you are already subscribed and getting this error, please <a href=\"https://</a>.\n    <br><br>\n            <a class=\"btn btn-lg btn-success\"  href=\"/register\">Sign Up Now</a>\n                    </p>\n                    </div>\n    </div>\n    <div class=\"row\" style=\"margin-top: 40px\">\n        <div class=\"col-sm-12 text-center\">\n            <p class=\"small\"><a href=\"/\">\n                    <i class=\"bi-house-fill\"></i> Home</a>\n                &emsp;\n                <a href=\"/control-panel\">\n                    <i class=\"bi-gear-fill\"></i> Control Panel</a>\n                &emsp;\n                <a href=\"/register\">\n                    <i class=\"bi-person-add\"></i> Create Account</a>\n                &emsp;\n\n                <a href=\"/login\">\n                    <i class=\"bi-door-open-fill\"></i> Login</a></p\u003e\n            <br>\n        </div>\n    </div>\n</div>\n</body>\n</html>\n",
        "request": "{\"service\":\"channels\",\"event\":\"sms.outbound\",\"payload\":{\"id\":\"cb66df55-a060-4f37-be91-c8b8b4c4221e\",\"channelId\":\"8652c8f7-11e2-5f63-a03f-f2998f8bc6f5\",\"sender\":{\"connector\":{\"id\":\"e60a0e31-bb8f-4d56-97e7-3e50b157512d\",\"identifierValue\":\"+12345678\"}},\"receiver\":{\"contacts\":[{\"id\":\"34f282bf-7e19-4224-a1a7-05a63e4cfac9\",\"identifierKey\":\"phonenumber\",\"identifierValue\":\"+123456789\",\"countryCode\":\"NL\"}]},\"body\":{\"type\":\"text\",\"text\":{\"text\":\"help\"}},\"meta\":{},\"reference\":\"\",\"parts\":[{\"platformReference\":\"cb66df55-a060-4f37-be91-c8b8b4c4221e:b2d7a013-86df-4aa7-8245-8f3715c87ae2\"}],\"status\":\"sent\",\"validity\":129600,\"reason\":\"\",\"direction\":\"outgoing\",\"chargeableUnits\":1,\"lastStatusAt\":\"2024-11-25T10:30:00.39Z\",\"createdAt\":\"2024-11-25T10:29:59.757Z\",\"updatedAt\":\"2024-11-25T10:30:00.39Z\",\"batchId\":null}}"
      }
    },
    {
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "subscriptionId": "0edf722b-93b4-4451-8a5d-4fafba5cdf8b",
      "requestId": "56878366-5417-414d-b1d9-5f250354f8d1",
      "attemptCount": 1,
      "httpStatusCode": 429,
      "executionStatus": "failed",
      "createdAt": "2024-11-25T10:30:00.777Z",
      "updatedAt": "2024-11-25T10:30:00.777Z",
      "payloadDetails": {
        "response": "<!DOCTYPE html>\n<html>\n<head>\n    <title>Error: Request limit exceeded. Sign up to unlock more requests.</title>\n    <link href=\"https://cdn.example.com/css/app.css\" rel=\"stylesheet\">\n</head>\n<body>\n<div class=\"container\" style=\"padding: 50px\">\n    <div class=\"row\">\n        <div class=\"col-sm-12 text-center\">\n            <h1><img src=\"https://cdn.webhook.site/icon.png\" alt=\"Logo\" style=\"width:40px; margin-top: -5px\">\X</h1>\n\n            <p class=\"lead\">Request limit exceeded. Sign up .</p>\n        </div>\n    </div>\n    <div class=\"row\">\n        <div class=\"col-sm-4 col-sm-offset-4 text-center\">\n                            <p>\n                        You have been rate limited due to too many requests to this URL.\n    This is either because you have not purchased\n, or the endpoint has a rate limit.<br>\n    <br>\n    To remove the request limit limit.\n    <br><br>\n    If you are already subscribed and getting this error, please <a href=\"https://</a>.\n    <br><br>\n            <a class=\"btn btn-lg btn-success\"  href=\"/register\">Sign Up Now</a>\n                    </p>\n                    </div>\n    </div>\n    <div class=\"row\" style=\"margin-top: 40px\">\n        <div class=\"col-sm-12 text-center\">\n            <p class=\"small\"><a href=\"/\">\n                    <i class=\"bi-house-fill\"></i> Home</a>\n                &emsp;\n                <a href=\"/control-panel\">\n                    <i class=\"bi-gear-fill\"></i> Control Panel</a>\n                &emsp;\n                <a href=\"/register\">\n                    <i class=\"bi-person-add\"></i> Create Account</a>\n                &emsp;\n\n                <a href=\"/login\">\n                    <i class=\"bi-door-open-fill\"></i> Login</a></p\u003e\n            <br>\n        </div>\n    </div>\n</div>\n</body>\n</html>\n",
        "request": "{\"service\":\"channels\",\"event\":\"sms.outbound\",\"payload\":{\"id\":\"cb66df55-a060-4f37-be91-c8b8b4c4221e\",\"channelId\":\"8652c8f7-11e2-5f63-a03f-f2998f8bc6f5\",\"sender\":{\"connector\":{\"id\":\"e60a0e31-bb8f-4d56-97e7-3e50b157512d\",\"identifierValue\":\"+12345678\"}},\"receiver\":{\"contacts\":[{\"id\":\"34f282bf-7e19-4224-a1a7-05a63e4cfac9\",\"identifierKey\":\"phonenumber\",\"identifierValue\":\"+123456789\",\"countryCode\":\"NL\"}]},\"body\":{\"type\":\"text\",\"text\":{\"text\":\"help\"}},\"meta\":{},\"reference\":\"\",\"parts\":[{\"platformReference\":\"cb66df55-a060-4f37-be91-c8b8b4c4221e:b2d7a013-86df-4aa7-8245-8f3715c87ae2\"}],\"status\":\"sent\",\"validity\":129600,\"reason\":\"\",\"direction\":\"outgoing\",\"chargeableUnits\":1,\"lastStatusAt\":\"2024-11-25T10:30:00.39Z\",\"createdAt\":\"2024-11-25T10:29:59.757Z\",\"updatedAt\":\"2024-11-25T10:30:00.39Z\",\"batchId\":null}}"
      }
    }
  ]
}

List all logs for a webhook subscription
Get webhook log details by request ID

Get webhook log details by request ID

get

This endpoint allows you to get the details of a webhook log using the request ID.

Authorizations
Path parameters
organizationIdstring · uuidRequired

The ID for the organization.

Example: cb28a94e-8557-4394-80ea-5bbd2170d434
workspaceIdstring · uuidRequired

The ID for the workspace.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61
webhookSubscriptionIdstring · uuidRequired

The ID for the webhook subscription.

Example: 852883af-5f68-4204-b611-7ee8db9600f4
Query parameters
requestIdstring · uuidRequired

The ID for the request.

Example: 5bfb1e8d-e12f-4f39-b723-f22699754436
Responses
200
Webhook log details are returned successfully. If no details exists, an empty list is returned.
application/json
get
GET /organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}/logs/details HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
200

Webhook log details are returned successfully. If no details exists, an empty list is returned.

{
  "results": [
    {
      "requestId": "123e4567-e89b-12d3-a456-426614174000",
      "attemptCount": 1,
      "httpStatusCode": 1,
      "executionStatus": "succeeded",
      "createdAt": "2025-05-28T20:30:06.689Z",
      "payloadDetails": {
        "response": "text",
        "request": "text"
      }
    }
  ]
}
  • GETList all logs for a webhook subscription.
  • GETGet webhook log details by request ID
  • Examples

List all logs for a webhook subscription.

get

This endpoint allows you to list all logs for a webhook subscription. You can filter the logs by execution status.

Authorizations
Path parameters
organizationIdstring · uuidRequired

The ID for the organization.

Example: cb28a94e-8557-4394-80ea-5bbd2170d434
workspaceIdstring · uuidRequired

The ID for the workspace.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61
webhookSubscriptionIdstring · uuidRequired

The ID for the webhook subscription.

Example: 852883af-5f68-4204-b611-7ee8db9600f4
Query parameters
limitinteger · min: 1 · max: 100Optional

Limits the number of results to return. The default value is 10, the minimum is one and the maximum is 100.

Default: 10
pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list. Use it to get remaining results that were paginated. To learn more, please refer to Common API Usage Pagination section.

executionStatusstring · enumOptional

The execution status of a webhook.

Possible values:
Responses
200
A list of webhook logs is returned successfully. If no logs exists, an empty list is returned.
application/json
Responseall of
get
GET /organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}/logs HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
200

A list of webhook logs is returned successfully. If no logs exists, an empty list is returned.

{
  "results": [
    {
      "requestId": "123e4567-e89b-12d3-a456-426614174000",
      "attemptCount": 1,
      "httpStatusCode": 1,
      "executionStatus": "succeeded",
      "createdAt": "2025-05-28T20:30:06.689Z"
    }
  ],
  "nextPageToken": "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ=="
}
Example of a delivery attempt. You can obtain the request ID on the headers through the key 'messagebird-request-id'
pagination documentation