HEhel
Webhooks

Create a Subscription Webhook

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

post/v1/webhook/paylink/subscription

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/webhook/paylink/subscription
  • Auth
    HTTP bearer

Query parameters

apiKeystring required

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

Request body

eventsstring[] required

List of subscription lifecycle events that will trigger the webhook. Supported values are 'STARTED', 'RENEWED', and 'ENDED'.

paylinkIdstring required

The ID of the pay link associated with the subscription.

targetUrlstring required

The URL that will receive webhook notifications for subscription events.

Response

Webhook creation response

eventsstring[] required
idstring required
paylinkstring required
companystring required
targetUrlstring required
sharedTokenstring required
creatorstring

Changes

No recorded changes to this operation across all 2 revisions of this API.