Skip to main content
POST
Create a Subscription 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
events
enum<string>[]
required

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

Available options:
STARTED,
RENEWED,
ENDED

The ID of the pay link associated with the subscription.

targetUrl
string
required

The URL that will receive webhook notifications for subscription events.

Response

Webhook creation response

events
enum<string>[]
required
Available options:
STARTED,
RENEWED,
ENDED
id
string
required
company
string
required
targetUrl
string
required
sharedToken
string
required
creator
string