Webhooks

Create a Pay Link Webhook

Create a webhook to listen for transaction events on a specific pay link.

post/v1/webhook/paylink/transaction

Query parameters

apiKeystring required

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

events'CREATED' required

The type of event that triggers the webhook. Use 'CREATED'.

paylinkIdstring required

The ID of the pay link the webhook is associated with.

targetUrlstring required

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

Webhook created successfully.

events'CREATED' required

idstring required

paylinkstring required

companystring required

targetUrlstring required

sharedTokenstring required

creatorstring

No recorded changes to this endpoint across all 1 revision of this API.