Skip to main content
POST
/
v1
/
webhook
/
paylink
/
subscription
Create a Subscription Webhook
curl --request POST \
  --url https://api.hel.io/v1/webhook/paylink/subscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "paylinkId": "<string>",
  "targetUrl": "<string>"
}
'
[
  {
    "id": "679cb0a5eafd565eeab89605",
    "paylink": "679bb9db7f3c16eb86bb1c67",
    "company": "6683f4efc330474ede1f25aa",
    "targetUrl": "https://target-url.com/post-endpoint",
    "events": [
      "STARTED",
      "RENEWED",
      "ENDED"
    ],
    "sharedToken": "ZtiSEjZsTNoczv8kvDgtSx5+YO017NOlM/mrqEMj2nnHXi+UfmCQvuqvZlI0eH3JJWrW1D3UDWM+GgK9sVfR0NNPIMwWNV+jcFehjDIMlVq05Ahf2/5tUT/W7qqiHWZy"
  }
]
NOTE: When using Helio on mainnet, set your Base URL to https://api.hel.io and generate your API keys from moonpay.hel.io . For testnet, use https://api.dev.hel.io and generate your API keys from moonpay.dev.hel.io.

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
​
paylinkId
string
required

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