Skip to main content
POST
JavaScript

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.

Path Parameters

id
string<uuid>
required

Unique identifier of the webhook subscription.

Response

200 - application/json

The newly created webhook event. Poll its delivery via GET /v1/webhook_deliveries?event_id={id} for receiver status.

id
string<uuid>
required

Unique identifier of the event. Matches the envelope id delivered in the webhook payload and is stable across subscription fan-out and retries.

type
enum<string>
required

Resource type discriminator.

Available options:
event
event_type
enum<string>
required

Event type.

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,
account_holder.active,
account_holder.closed,
ping.test
api_version
string
required

API version the event payload was rendered at. Stable across retries and redeliveries, and mirrored in the webhook envelope api_version field.

created_at
string<date-time>
required

ISO 8601 UTC timestamp when the event was created.

data
object
required

Event payload. Shape matches the resource schema for event_type.