Skip to main content
POST
Send test event

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.

Example:

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

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.

Example:

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

type
enum<string>
required

Resource type discriminator.

Available options:
event
event_type
enum<string>
required

Event type.

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,
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.

Example:

"2026-05-01"

created_at
string<date-time>
required

ISO 8601 UTC timestamp when the event was created.

Example:

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

data
object
required

Event payload. Shape matches the resource schema for event_type.