Webhooks

Register a webhook subscription

Creates a subscription and returns the one-time signing secret.

Required entitlement: regulated.api-clients.canManageWebhooks
Entitles the regulated user to create, view, update, rotate, delete, and replay webhook subscriptions for B2B event delivery

post/api-regulated/v1/webhook-subscriptions

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/webhook-subscriptions
  • Auth: OAuth 2 (implicit, authorization URL https://auth.currencyguard.com/oauth2/authorize, scopes: regulated.api-clients.canManageWebhooks)

Request body

subscriptionNamestring required

Human-readable name for this subscription, unique within your regulated entity

endpointUrlstring required

HTTPS endpoint to which signed event payloads will be POSTed

Example request

{
  "subscriptionName": "Production order book",
  "endpointUrl": "https://psp.example.com/webhooks/currencyguard"
}

Response

Subscription created

idstring uuid

ID of the created subscription

subscriptionNamestring

Subscription name

endpointUrlstring

Endpoint URL

statusstring

Subscription status

signingSecretstring

HMAC-SHA256 signing secret — shown only once. Store it securely; it cannot be retrieved later.

createdAtstring

Timestamp of creation in UTC

messagestring

Human-readable note about the one-time secret

Example response

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "subscriptionName": "Production order book",
  "endpointUrl": "https://psp.example.com/webhooks/currencyguard",
  "status": "ACTIVE",
  "signingSecret": "whsec_3J8x...redacted...",
  "createdAt": "2026-06-13T12:30:40Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.