Get a Single Webhook Subscription by Its Unique ID

GET /v1/webhook-subscriptions/ — Fetch the full configuration of a webhook subscription by ID. The signing secret is never returned after creation.

Use this endpoint to fetch the full configuration of a single webhook subscription by its UUID. The response includes the subscription’s name, target URL, subscribed event types, and active status. For security reasons, the secret is never returned after initial creation — if your secret has been compromised, rotate it using the Update Subscription endpoint.

​

Endpoint

GET /v1/webhook-subscriptions/{id}

Required scope: webhooks.read

​

Request Headers

Header	Required	Description
Authorization	Yes	Bearer {access_token}

​

Path Parameters

id · string · required

The UUID of the webhook subscription to retrieve.

​

Response — 200 OK

id · string

UUID of the webhook subscription.

name · string

Human-readable label for this subscription.

url · string

The registered HTTPS endpoint that receives event payloads.

eventTypes · array

The list of event type strings this subscription is configured to receive. An empty array indicates a subscription to all events.

isActive · boolean

true if the subscription is currently delivering events.

createdAt · string

ISO 8601 timestamp of when the subscription was created.

updatedAt · string

ISO 8601 timestamp of the most recent update to the subscription.

The secret field is intentionally omitted from this response. If you believe your secret has been exposed, rotate it immediately by issuing a PUT /v1/webhook-subscriptions/ request with a new secret value.

​

Examples

​

Retrieve a subscription by ID

curl --request GET \
  --url https://api.diameterpay.com/v1/webhook-subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  --header 'Authorization: Bearer {access_token}'

​

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Payment Notifications",
  "url": "https://hooks.yourapp.com/diameter/payments",
  "eventTypes": [
    "PAYMENT_WIRE_OUTBOUND_COMPLETED",
    "PAYMENT_WIRE_OUTBOUND_FAILED",
    "PAYMENT_WIRE_INBOUND_POSTED",
    "PAYMENT_ACH_RECEIVER_CREDIT_POSTED"
  ],
  "isActive": true,
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-03T08:45:00.000Z"
}

​

Error Responses

Status	Description
404 Not Found	No subscription with the given id exists for your tenant.
403 Forbidden	Your token does not have the webhooks.read scope.