Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

Same flow; ledger:write is required for any mutation.

Body

application/json
url
string<uri>
required
Example:

"https://acme.example.com/webhooks/kordio"

description
string
Example:

"Production handler"

enabled_events
string[]
Example:

Response

Endpoint created. Body includes one-time signing_secret.

object
enum<string>
required

Discriminator naming the shape of this resource (e.g. account, transaction).

Available options:
webhook_endpoint
Example:

"account"

id
string<uuid>
required
url
string<uri>
required
active
boolean
required
description
string
mode
enum<string>
Available options:
live,
test
enabled_events
string[]
last_delivered_at
string<date-time> | null
created_at
string<date-time>
signing_secret
string

Returned only on create + rotate.

signing_secret_note
string

Hint to the integrator that the secret is shown once.