Skip to main content
POST
/
v1
/
webhook
/
paylink
/
transaction
Create a Pay Link Webhook
curl --request POST \
  --url https://api.hel.io/v1/webhook/paylink/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": "CREATED",
  "paylinkId": "<string>",
  "targetUrl": "<string>"
}
'
{
  "id": "6812aec64b14347beb071599",
  "creator": "undefined",
  "paylink": "67e548619967b38ac797d6ce",
  "company": "667c1f9352919e407156128c",
  "targetUrl": "https://webhook.site/68644b4f-f63c-4815-9b25-51487efbf13a",
  "events": [
    "CREATED"
  ],
  "sharedToken": "vF5C1KZKiGE44mJ2NOYPPeGewkNfWE3JWSaa1EYAsh1tltpPE9BUtg+0GG8YMzLw3GTLIwsOWMajaHUO7bfLQ/hP9lg4q9Zo6Lv4zDqN8eUH5bBil2O6KFv6bdW+dXFv"
}
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

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

Available options:
CREATED
​
paylinkId
string
required

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

​
targetUrl
string
required

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

Response

Webhook created successfully.

​
events
enum<string>
required
Available options:
CREATED
​
id
string
required
​
paylink
string
required
​
company
string
required
​
targetUrl
string
required
​
sharedToken
string
required
​
creator
string