Skip to main content
POST
Create a webhook endpoint

Authorizations

Api-Key
string
header
required

Headers

Idempotency-Key
string
required

Body

application/json

Information about the webhook endpoint to be created

url
string
required

The URL that the webhook will send events to. It must use the HTTPS scheme and have a valid X.509 certificate. The URL doesn't need to be live, but the host must be reachable.

Minimum string length: 1
event_epoch
enum<string>
required

Specifies the starting point from which this webhook will receive events. This should usually be set to "webhook_creation", unless there is a reason why this webhook needs to process events from before its creation. When this value is set to "webhook_creation", the webhook will receive a small number of events preceding its creation for convenience.

Available options:
webhook_creation,
beginning_of_time
event_categories
enum<string>[]

The list of event categories that the webhook endpoint will receive

The category of the webhook event

Available options:
customer,
kyc_link,
liquidation_address.drain,
static_memo.activity,
transfer,
virtual_account.activity,
bridge_wallet.activity,
card_account,
card_transaction,
card_withdrawal,
posted_card_account_transaction,
external_account

Response

Webhook endpoint created

id
string
required

An identifier that uniquely identifies the webhook endpoint

Pattern: ^wep_[a-f0-9]+$
url
string
required

The URL that the webhook will send events to

status
enum<string>
required

The status of the webhook. Only active webhooks will receive events automatically.

Available options:
active,
disabled,
deleted
public_key
string
required

The public key (in PEM format) that should be used to verify the authenticity of webhook events

event_categories
enum<string>[]

The list of event categories that the webhook endpoint will receive

The category of the webhook event

Available options:
customer,
kyc_link,
liquidation_address.drain,
static_memo.activity,
transfer,
virtual_account.activity,
bridge_wallet.activity,
card_account,
card_transaction,
card_withdrawal,
posted_card_account_transaction,
external_account