Create webhook subscription

Creates a new webhook subscription.

POST /v1/webhook_subscriptions

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
});

const webhookSubscription = await client.webhookSubscriptions.create({
  events: ['payout.created'],
  url: 'https://example.com',
});

console.log(webhookSubscription.id);

200

{
  "id": "<string>",
  "url": "<string>",
  "events": [],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key · string

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json

Webhook subscription creation parameters

url · string<uri> · required

The HTTPS URL where webhook events will be delivered.

events · enum<string>[] · required

Event types to subscribe to. Use ["*"] for all events.

Minimum array length: 1

Event type to subscribe to. Use "*" for all events.

Available options: payout.created, payout.initiated, payout.paid, payout.failed, return.initiated, return.paid, return.failed, return.returned, deposit.received, conversion.created, conversion.completed, conversion.failed, *

Response

200 - application/json

Success

id · string · required

Unique identifier of the webhook subscription.

type · enum<string> · required

Resource type discriminator.

Available options: webhook_subscription

url · string · required

The HTTPS URL where webhook events are delivered.

events · enum<string>[] · required

Event types this subscription receives.

Event type the subscription receives.

Available options: payout.created, payout.initiated, payout.paid, payout.failed, return.initiated, return.paid, return.failed, return.returned, deposit.received, conversion.created, conversion.completed, conversion.failed

created_at · string<date-time> · required

ISO 8601 UTC timestamp when the subscription was created.

updated_at · string<date-time> · required

ISO 8601 UTC timestamp when the subscription was last updated.