Skip to main content
GET
/
v1
/
webhook_deliveries
/
{id}
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
});

const webhookDelivery = await client.webhookDeliveries.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(webhookDelivery.id);
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Path Parameters

​
id
string<uuid>
required

Unique identifier of the webhook delivery.

Response

200 - application/json

The webhook delivery resource

​
id
string<uuid>
required

Unique identifier of the webhook delivery.

​
type
enum<string>
required

Resource type discriminator.

Available options:
webhook_delivery
​
event_id
string<uuid>
required

Identifier of the event this delivery was for.

​
subscription_id
string<uuid>
required

Identifier of the webhook subscription this delivery targeted.

​
status
enum<string>
required

Current status of the delivery.

Available options:
pending,
delivered,
failed,
processing,
ignored
​
attempts
object[]
required

Ordered list of HTTP delivery attempts for this delivery.

​
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the delivery was created.

​
updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the delivery was last updated.