Skip to main content
POST
/
webhooks
Register a webhook
curl --request POST \
  --url https://api.zet.money/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://yourapp.com/webhooks/zet",
  "events": [
    "onramp.completed",
    "offramp.completed"
  ],
  "description": "Production payment webhook"
}
'
{
  "success": true,
  "data": {
    "id": "wh_01H8X7...",
    "url": "https://yourapp.com/webhooks/zet",
    "events": [
      "onramp.completed",
      "offramp.completed"
    ],
    "secret": "whsec_abc123...",
    "isActive": true,
    "description": "Production payment webhook",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

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:
["onramp.completed", "offramp.completed"]
​
description
string

Optional description for this webhook.

Example:

"Production payment webhook"

Response

Webhook registered. Store the secret securely.

​
success
boolean
Example:

true

​
data
object