Webhooks

Get a specific webhook by ID

Returns webhook configuration including URL, events, active status, and DisabledReason if auto-disabled. Secret is never included (only shown during creation/regeneration).

get/v1/Webhooks/{id}

Request

  • Base URL
    https://referral-api.debitura.com
  • URL
    https://referral-api.debitura.com/v1/Webhooks/{id}
  • Auth
    API key in header XApiKey

Path parameters

idstring uuid required

Response

Webhook details

idstring uuid

Unique identifier for the webhook subscription.

urlstring nullable

The HTTPS URL where webhook events will be delivered.

eventsstring[] nullable

Array of event types this subscription is interested in.

isActiveboolean

Whether this webhook subscription is active.

createdUtcstring date-time

Timestamp when the webhook subscription was created (UTC).

updatedUtcstring date-time

Timestamp when the webhook subscription was last updated (UTC).

disabledReasonstring nullable

Reason why the webhook was automatically disabled (if IsActive is false).

secretstring nullable

Secret key for HMAC-SHA256 signature verification. Only returned on creation or secret regeneration — never exposed again for security.

isTestModeboolean

True when the subscription has DataClassification.Test classification; false for all other classifications (Production, Demo). Computed as Classification != DataClassification.Production.

Changes

No recorded changes to this operation across all 11 revisions of this API.