Skip to main content
POST
Register a webhook

Authorizations

x-api-key
string
header
required

Your Zet API key. Contact zetdotmoney@gmail.com to obtain your keys.

Body

application/json
url
string<uri>
required

HTTPS URL to receive webhook POST requests.

Example:

"https://yourapp.com/webhooks/zet"

events
enum<string>[]
required

List of event types to subscribe to. Use * for all events.

Available options:
onramp.completed,
onramp.failed,
offramp.completed,
offramp.failed,
swap.completed,
swap.failed,
transfer.completed,
transfer.failed,
*
Example:
description
string

Optional description for this webhook.

Example:

"Production payment webhook"

Response

Webhook registered. Store the secret securely.

success
boolean
Example:

true

data
object