Register webhook
Register a new webhook and receive callbacks.
Authorizations
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.
Body
The list of events to subscribe to.
1The type of event that occurred.
network.token.updated, pci.token.security-code.expired The URL to which the webhook will send event notifications.
"https://merchant.com.example/webhooks/guardian"
The HMAC key to be used to sign the payloads sent to the webhook URL.
"c2VjcmV0LXdlYmhvb2stc2lnbmluZy1rZXk="
Response
Success response
The unique identifier for the webhook.
"2f8d4b6c-9e1a-4c7f-b3d5-8a6e2c9f4b1d"
The timestamp when the webhook was created.
"2026-01-20T08:30:00Z"
The list of events the webhook is subscribed to.
1The type of event that occurred.
network.token.updated, pci.token.security-code.expired The URL to which the webhook sends event notifications.
"https://merchant.com.example/webhooks/guardian"
The masked HMAC key used to sign the payloads sent to the webhook URL.
"123xxxx"