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:
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.
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.
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.
