Skip to main content
POST
/
v1
/
webhook
/
paylink
/
api-key
Create a Webhook
curl --request POST \
  --url https://api.hel.io/v1/webhook/paylink/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "targetUrl": "<string>",
  "paylinkId": "<string>"
}
'
{
  "id": "1234567890abcdef12345678",
  "name": "Example Webhook",
  "targetUrl": "https://example.com/webhook",
  "inactive": false,
  "createdAt": "2025-06-25T00:00:00.000Z",
  "paylink": "abcdef1234567890abcdef12",
  "isGlobal": true,
  "sharedToken": "dummySharedToken1234567890+/exampletoken=="
}
Note: When using the production environment at moonpay.hel.io, set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from moonpay.dev.hel.io.

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

The name of the webhook.

​
targetUrl
string
required

The URL that will receive the webhook payload when the event occurs.

​
paylinkId
string

The ID of the pay link the webhook is associated with. This field is optional — leave it blank to create a global webhook.

Response

Webhook created successfully.

​
events
enum<string>
required
Available options:
CREATED
​
id
string
required
​
paylink
string
required
​
company
string
required
​
targetUrl
string
required
​
sharedToken
string
required
​
creator
string