v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB

Webhooks

Create a Withdrawal Webhook

Create a webhook to receive withdrawal lifecycle events (SUBMITTED, CONFIRMED, FAILED, REFUNDED_BY_PROVIDER). Requires an API key with the WEBHOOK_CREATE permission.

post/v1/webhook/withdrawal/api-key

Query parameters

apiKeystring required

Your API key can be generated on the Helio Dashboard's settings page.

Request body

namestring required

Webhook name.

targetUrlstring uri required

URL that receives webhook payloads.

eventsWithdrawalHookEvent[] required

Response

Webhook created successfully.

idstring

namestring

targetUrlstring

eventsWithdrawalHookEvent[]

inactiveboolean

sharedTokenstring

Bearer token and HMAC key for verifying deliveries.

createdAtstring date-time