Skip to main content
POST
/
api
/
admin
/
webhooks
Register webhook
curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/admin/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "events": [
    "network.token.updated"
  ],
  "url": "<string>",
  "hmac_key": "<string>"
}
'
{
  "id": "5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d",
  "created_at": "2023-10-05T14:48:00.000Z",
  "url": "https://my-webhook-endpoint.com/webhooks",
  "events": [
    "network.token.updated",
    "pci.token.security-code.expired"
  ],
  "masked_hmac_key": "123xxxx"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
events
enum<string>[]
required

The list of events to subscribe to.

Minimum array length: 1

The type of event that occurred.

Available options:
network.token.updated,
pci.token.security-code.expired
​
url
string<uri>
required

The URL to which the webhook will send event notifications.

​
hmac_key
string

The HMAC key to be used to sign the payloads sent to the webhook URL.

Response

Success response

​
id
string<uuid>
required

The unique identifier for the webhook.

​
created_at
string<date-time>
required

The timestamp when the webhook was created.

​
events
enum<string>[]
required

The list of events the webhook is subscribed to.

Minimum array length: 1

The type of event that occurred.

Available options:
network.token.updated,
pci.token.security-code.expired
​
url
string<uri>
required

The URL to which the webhook sends event notifications.

​
masked_hmac_key
string

The masked HMAC key used to sign the payloads sent to the webhook URL.

Example:

"123xxxx"