Webhook subscription logs

All webhook logs of a subscription 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.

1. List all logs for a webhook subscription

2. Get webhook log details by request ID

List all logs for a webhook subscription.

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

GEThttps://nest.messagebird.one/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}/logs

Path parameters

organizationId*Organization ID

The ID for the organization.

Example: "cb28a94e-8557-4394-80ea-5bbd2170d434"

workspaceId*Workspace ID

The ID for the workspace.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

webhookSubscriptionId*WebhookSubscriptionID

The ID for the webhook subscription.

Example: "852883af-5f68-4204-b611-7ee8db9600f4"

Query parameters

Response

200

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

Body

application/json

resultsarray of Notifications_WebhookLog (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('https://nest.messagebird.one/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "requestId": "123e4567-e89b-12d3-a456-426614174000",
      "executionStatus": "succeeded",
      "createdAt": "2024-11-21T08:56:55.181Z"
    }
  ],
  "nextPageToken": "text"
}

Get webhook log details by request ID

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

GEThttps://nest.messagebird.one/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}/logs/details

Path parameters

organizationId*Organization ID

The ID for the organization.

Example: "cb28a94e-8557-4394-80ea-5bbd2170d434"

workspaceId*Workspace ID

The ID for the workspace.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

webhookSubscriptionId*WebhookSubscriptionID

The ID for the webhook subscription.

Example: "852883af-5f68-4204-b611-7ee8db9600f4"

Query parameters

Response

200

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

Body

application/json

resultsarray of Notifications_WebhookLogWithDetails (object)

Request

JavaScriptCurlPython

const response = await fetch('https://nest.messagebird.one/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}/logs/details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "requestId": "123e4567-e89b-12d3-a456-426614174000",
      "executionStatus": "succeeded",
      "createdAt": "2024-11-21T08:56:55.181Z",
      "payloadDetails": {
        "response": "text",
        "request": "text"
      }
    }
  ]
}