Skip to main content
POST
/
api
/
admin
/
webhooks
Register webhook
curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "url": "https://merchant.example.com/webhooks/specter"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "events": [
    "<string>"
  ],
  "hmac_key": "<string>",
  "inserted_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Body

application/json

Webhook attributes

​
events
enum<string>[]
required

Event types this endpoint is subscribed to. Must contain at least one.

Minimum array length: 1
Available options:
decision.allow,
decision.block,
decision.review,
decision.provisional,
decision.async.allow,
decision.async.block,
decision.async.review
​
url
string<uri>
required

HTTPS URL that Specter delivers event notifications to.

Example:

"https://merchant.example.com/webhooks/specter"

Response

Created webhook

Returned only on initial creation. Contains the plaintext hmac_key — store it securely, it will not be shown again.

​
id
string<uuid>
​
events
string[]
​
hmac_key
string | null

Plaintext HMAC key. Only returned once.

​
inserted_at
string<date-time>
​
updated_at
string<date-time>
​
url
string<uri>