List webhook deliveries

Lists webhook deliveries for the merchant with cursor-based pagination. Deliveries are retained for 30 days.

GET /v1/webhook_deliveries

JavaScript

JavaScript

import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const webhookDeliveryListResponse of client.webhookDeliveries.list()) {
  console.log(webhookDeliveryListResponse.id);
}

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attempts": [
        {
          "attempted_at": "2023-11-07T05:31:56Z",
          "status_code": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer token for authentication with Augustus Banking API

Query Parameters

limit · integer · default: 10

Number of results per page (1-100). Defaults to 10.

Required range: 1 < x < 100

cursor · string

Opaque cursor from a previous next_cursor.

event_id · string<uuid>

Filter by event ID.

subscription_id · string<uuid>

Filter by webhook subscription ID.

status · enum<string>

Filter by delivery status.

Available options: pending, delivered, failed, processing, ignored

created_at.gte · string<date-time>

Include deliveries whose created_at is greater than or equal to this ISO 8601 timestamp.

created_at.lte · string<date-time>

Include deliveries whose created_at is less than or equal to this ISO 8601 timestamp.

Response

200 - application/json

Paginated list of webhook deliveries

data · object[] · required

Show child attributes

has_more · boolean · required

next_cursor · string | null · required