HEhel
Webhooks

Create a Deposit Webhook

Create a webhook for a deposit.

post/v1/webhook/deposit/api-key

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/webhook/deposit/api-key
  • Auth
    HTTP bearer

Query parameters

apiKeystring required

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

Request body

namestring required

The name of the webhook.

depositIdstring required

The ID of the deposit the webhook is associated with.

targetUrlstring required

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

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.