Skip to content
/Webhooks

Guardian API (EAP)

Download OpenAPI description
guardian-openapi.json
guardian-openapi.yaml
Overview
URL

https://hellgate.io/cpa/guardian

Starfish GmbH & Co. KG

hello@starfish.team

License

Hellgate API Terms

Languages
Servers
Managed instance of Guardian CPA

https://{cluster_id}.on-hellgate.cloud/

PCI Tokens

Management of card payment credentials under the ruling of PCI/DSS.

Operations

Network Tokens

Management of network tokens, including cryptograms for secure transactions.

Operations

Metadata Inquiries

Inquiries for card metadata based on PAN, PCI tokens, or network tokens.

Operations

API Keys

Management of API keys for service access.

The capabilities an API keys has access to can be scoped to these areas:

  • API Keys
    • admin:api-keys:create
    • admin:api-keys:read
    • admin:api-keys:update
    • admin:api-keys:delete
  • Webhooks
    • admin:webhooks:create
    • admin:webhooks:read
    • admin:webhooks:delete
  • PCI Tokens
    • pci:tokens:create
    • pci:tokens:read
    • pci:tokens:update
    • pci:tokens:delete
    • pci:tokens:forward
  • Network Tokens
    • network:tokens:create
    • network:tokens:read
    • network:tokens:delete
    • network:tokens:use
  • Metadata Inquiries
    • metadata:inquiry:create
Operations

Webhooks

Management of webhooks for event notifications.

Guardian uses tiny events as notification payload. They give you the context of what happened and you can use this information to fetch more details via our API.

Please find the documentation about the callback on the endpoint that registers the webhook.

Operations

Register webhook

Request

Register a new webhook and receive callbacks.

Security
APIKey or AdminToken
Bodyapplication/json
eventsArray of stringsnon-emptyrequired

The list of events to subscribe to.

Items Enum"network.token.updated""pci.token.security-code.expired"
hmac_keystring

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

urlstring(uri)required

The URL to which the webhook will send event notifications.

curl -i -X POST \
  https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "events": [
      "network.token.updated"
    ],
    "url": "http://example.com"
  }'

Responses

Success response

Bodyapplication/json
idstring(uuid)required

The unique identifier for the webhook.

created_atstring(date-time)required

The timestamp when the webhook was created.

eventsArray of stringsnon-emptyrequired

The list of events the webhook is subscribed to.

Items Enum"network.token.updated""pci.token.security-code.expired"
masekd_hmac_keystring

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

Example: "123xxxx"
urlstring(uri)required

The URL to which the webhook sends event notifications.

Response
application/json
{
  "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"
  ],
  "masekd_hmac_key": "123xxxx"
}

Callbacks

Event notification callback
post

Get webhooks

Request

List all webhooks known to the system.

Security
APIKey or AdminToken
Query
limitinteger[ 1 .. 100 ]

The limit parameter defines the maximum number of rows returned in a single call and enables consecutive pagination using the next link provided in the response payload.

Default 20
curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks?limit=20' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
dataArray of itemsrequired
Example: [{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2023-10-01T12:00:00Z","masked_hmac_key":"123xxxx","events":["network.token.updated"],"url":"https://example.com/webhook"}]
data[].​[0]object
linksobjectrequired
Example: {"next":"https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20"}
links.​nextstring(uri)required
Example: "https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20"
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "next": "https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20"
  }
}

Get webhook details

Request

Retrieves detailed information about a specific webhook.

Security
APIKey or AdminToken
Path
idstring(uuid)required

The unique identifier of the webhook.

curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
idstring(uuid)required

The unique identifier for the webhook.

created_atstring(date-time)required

The timestamp when the webhook was created.

eventsArray of stringsnon-emptyrequired

The list of events the webhook is subscribed to.

Items Enum"network.token.updated""pci.token.security-code.expired"
masekd_hmac_keystring

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

Example: "123xxxx"
urlstring(uri)required

The URL to which the webhook sends event notifications.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "events": [
    "network.token.updated"
  ],
  "masekd_hmac_key": "123xxxx",
  "url": "http://example.com"
}
Starfish GmbH & Co. KG © 2025