Skip to main content
POST
Create a Webhook

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.

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
company
string
required
targetUrl
string
required
sharedToken
string
required
creator
string