Skip to main content
POST
Create webhook subscription

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
required

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.

Pattern: ^https:\/\/.*
Example:

"https://sandbox.example.com/webhooks/augustus"

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.initiated,
payout.submitted,
payout.sent,
payout.failed,
payout.returned,
return.initiated,
return.submitted,
return.sent,
return.failed,
return.returned,
deposit.settled,
conversion.created,
conversion.completed,
conversion.failed,
account_holder.active,
account_holder.closed,
counterparty.created,
counterparty.verified,
counterparty.rejected,
counterparty.blocked,
counterparty.unblocked,
counterparty.updated,
*
Example:
metadata
object | null

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example:

Response

200 - application/json

Success

id
string
required

Unique identifier of the webhook subscription.

Example:

"550e8400-e29b-41d4-a716-446655440009"

type
enum<string>
required

Resource type discriminator.

Available options:
webhook_subscription
url
string
required

The HTTPS URL where webhook events are delivered.

Example:

"https://sandbox.example.com/webhooks/augustus"

events
enum<string>[]
required

Event types this subscription receives.

Event type the subscription receives.

Available options:
payout.initiated,
payout.submitted,
payout.sent,
payout.failed,
payout.returned,
return.initiated,
return.submitted,
return.sent,
return.failed,
return.returned,
deposit.settled,
conversion.created,
conversion.completed,
conversion.failed,
account_holder.active,
account_holder.closed,
counterparty.created,
counterparty.verified,
counterparty.rejected,
counterparty.blocked,
counterparty.unblocked,
counterparty.updated
Example:
metadata
object
required

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example:
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the subscription was created.

Example:

"2026-01-15T10:30:00Z"

updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the subscription was last updated.

Example:

"2026-01-15T10:35:00Z"