Sign in

v1

latestOpenAPI 3.0.42026-08-042281222.0 KB
Webhooks

Get all webhooks for the authenticated referral partner

Returns all webhook subscriptions with their configuration (URL, events, status). Note: Secrets are never included in GET responses.

get/v1/Webhooks

Response

List of webhook subscriptions

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.