Get webhook details

GET

api

admin

webhooks

{id}

Get webhook details

curl --request GET \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "2f8d4b6c-9e1a-4c7f-b3d5-8a6e2c9f4b1d",
  "created_at": "2026-01-20T08:30:00Z",
  "events": [
    "network.token.updated"
  ],
  "url": "https://merchant.com.example/webhooks/guardian",
  "masked_hmac_key": "123xxxx"
}

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

{
  "code": 403,
  "message": "Not allowed to access this resource or feature",
  "classifier": "FORBIDDEN"
}

{
  "code": 404,
  "message": "The requested resource was not found.",
  "classifier": "NOT_FOUND"
}

Authorizations

Authorization

string

header

required

JWT bearer token obtained via the OAuth2 client-credentials grant from the platform Authentication API. The token's scopes gate the endpoints it may call, and its audience names the Guardian instance. This is the standard way to authenticate to Guardian.

Path Parameters

string<uuid>

required

The unique identifier of the webhook.

Response

Success response

string<uuid>

required

The unique identifier for the webhook.

Example:

"2f8d4b6c-9e1a-4c7f-b3d5-8a6e2c9f4b1d"

created_at

string<date-time>

required

The timestamp when the webhook was created.

Example:

"2026-01-20T08:30:00Z"

events

enum<string>[]

required

The list of events the webhook is subscribed to.

Minimum array length: 1

The type of event that occurred.

network.token.deleted is sent when a network token is deleted, whether through the API or by the card scheme. The token is no longer listed, and its related_object.url returns 404.

import.finished and import.failed are sent when an import completes or fails; related_object.id is the ID of the import.

wallet.apple_pay.certificate.expiring_soon is sent once a day for each Apple Pay certificate that expires within the next 30 days. wallet.apple_pay.certificate.compromised is sent when an Apple Pay certificate is disabled because it is suspected to be compromised. wallet.google_pay.key.disabled is sent when a Google Pay key is disabled. For these events, related_object.id is the ID of the certificate or key.

Available options:

network.token.updated,

network.token.deleted,

pci.token.security-code.expired,

import.finished,

import.failed,

wallet.apple_pay.certificate.expiring_soon,

wallet.apple_pay.certificate.compromised,

wallet.google_pay.key.disabled

url

string<uri>

required

The URL to which the webhook sends event notifications.

Example:

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

masked_hmac_key

string | null

The masked HMAC key used to sign the payloads sent to the webhook URL. null when the webhook has no HMAC key.

Example:

"123xxxx"

⌘I

Get webhook details

curl --request GET \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "2f8d4b6c-9e1a-4c7f-b3d5-8a6e2c9f4b1d",
  "created_at": "2026-01-20T08:30:00Z",
  "events": [
    "network.token.updated"
  ],
  "url": "https://merchant.com.example/webhooks/guardian",
  "masked_hmac_key": "123xxxx"
}

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

{
  "code": 403,
  "message": "Not allowed to access this resource or feature",
  "classifier": "FORBIDDEN"
}

{
  "code": 404,
  "message": "The requested resource was not found.",
  "classifier": "NOT_FOUND"
}

Getting Started

Tokens

Metadata

Admin

Authorizations

Path Parameters

Response