Sign in

v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Webhooks

Create a Webhook

Create a global or pay link webhook using this endpoint. To create a global webhook, do not specify a paylinkId.

post/v1/webhook/paylink/api-key

Query parameters

apiKeystring required

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

Request body

namestring required

The name of the webhook.

paylinkIdstring

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

targetUrlstring required

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

Response

Webhook created successfully.

events'CREATED' required
idstring required
paylinkstring required
companystring required
targetUrlstring required
sharedTokenstring required
creatorstring