Webhooks

Get a webhook subscription

Returns one subscription owned by the authenticated regulated entity, including delivery status.

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

get/api-regulated/v1/webhook-subscriptions/{id}

Request

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

Path parameters

idstring uuid required

Response

Subscription retrieved

idstring uuid

ID for this webhook subscription

subscriptionNamestring

Human-readable name for this subscription, unique per regulated entity

endpointUrlstring

HTTPS endpoint to which signed event payloads are POSTed

status'ACTIVE' | 'PAUSED' | 'DISABLED' | 'DELETED'

Status of this subscription

lastEventSequenceinteger

Highest event sequence number delivered to this subscription. -1 means nothing delivered yet.

lastPushAtstring

Timestamp of the most recent delivery attempt in UTC

lastPushStatusinteger

HTTP status code returned by the most recent delivery attempt

lastErrorMessagestring

Error message from the most recent failed delivery attempt

consecutiveFailuresinteger

Number of consecutive delivery failures. Reset to 0 on success; subscription auto-pauses when the configured threshold is reached.

pausedAtstring

Timestamp when this subscription was paused (auto or manual) in UTC

updatedAtstring

Timestamp of the last update in UTC

createdAtstring

Timestamp of creation in UTC

Example response

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "subscriptionName": "Production order book",
  "endpointUrl": "https://psp.example.com/webhooks/currencyguard",
  "status": "ACTIVE",
  "lastEventSequence": 48201,
  "lastPushAt": "2026-05-30T14:23:01Z",
  "lastPushStatus": 200,
  "lastErrorMessage": "Connection timed out after 10s",
  "pausedAt": "2026-05-30T14:23:01Z",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

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