Skip to main content
POST
Create a Withdrawal Webhook
NOTE: When using Helio on mainnet, set your Base URL to https://api.hel.io and generate your API keys from moonpay.hel.io. For testnet, use https://api.dev.hel.io and generate your API keys from moonpay.dev.hel.io.
Subscribe to SUBMITTED, CONFIRMED, FAILED, and REFUNDED_BY_PROVIDER events. Deliveries include Authorization: Bearer <sharedToken> and an X-Signature HMAC-SHA256 header keyed with the same token. See the Withdrawals guide for payload details.

Authorizations

Authorization
string
header
required

Authentication using JWT token

Query Parameters

apiKey
string
required

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

Body

application/json
name
string
required

Webhook name.

Maximum string length: 64
targetUrl
string<uri>
required

URL that receives webhook payloads.

events
enum<string>[]
required
Minimum array length: 1
Available options:
SUBMITTED,
CONFIRMED,
FAILED,
REFUNDED_BY_PROVIDER

Response

Webhook created successfully.

id
string
name
string
targetUrl
string
events
enum<string>[]
Available options:
SUBMITTED,
CONFIRMED,
FAILED,
REFUNDED_BY_PROVIDER
inactive
boolean
sharedToken
string

Bearer token and HMAC key for verifying deliveries.

createdAt
string<date-time>