WebhookSubscriptionResponse

subscriptionIdstringrequired

Example: sub_01HZY7E6R4G7Z2M6D3T0Q9X4K5

entityWebhookEntity (string)required

Possible values: [OPT_IN_CREATED, OPT_IN_RECURRENCE_UPDATED, SCHEDULE_ACCESS_REQUEST, COLLECTION_CONTRACT_CREATION, COLLECTION_CONTRACT, COLLATERALIZED_CREDIT_CONTRACT, COLLATERALIZED_CREDIT_ESCROW_ACCOUNT]

Example: COLLECTION_CONTRACT

webhookUrlstring<uri>required

Example: https://example.com/destrava/webhooks

activebooleanrequired

Compatibility flag for delivery eligibility. Prefer status for UI state.

Example: true

statusWebhookSubscriptionStatus (string)required

ACTIVE deliveries are eligible, PAUSED keeps the configuration without new deliveries, and DEACTIVATED is logical removal with history preserved.

Possible values: [ACTIVE, PAUSED, DEACTIVATED]

Example: ACTIVE

signatureSecretConfiguredbooleanrequired

True when an HMAC signing secret is configured; the raw secret is never returned.

Example: true

createdAtstring<date-time>required

Example: 2026-06-17T12:00:00Z

updatedAtstring<date-time>required

Example: 2026-06-17T12:10:00Z

auth object

typeWebhookAuthType (string)required

Possible values: [BASIC, BEARER, API_KEY]

Example: API_KEY

loginstring

Non-secret auth identifier. The secret value is never returned.

Example: X-Webhook-Key

configuredbooleanrequired

True when an outbound auth secret is configured.

Example: true

WebhookSubscriptionResponse

{
  "subscriptionId": "sub_01HZY7E6R4G7Z2M6D3T0Q9X4K5",
  "entity": "COLLECTION_CONTRACT",
  "webhookUrl": "https://example.com/destrava/webhooks",
  "active": true,
  "status": "ACTIVE",
  "signatureSecretConfigured": true,
  "createdAt": "2026-06-17T12:00:00Z",
  "updatedAt": "2026-06-17T12:10:00Z",
  "auth": {
    "type": "API_KEY",
    "login": "X-Webhook-Key",
    "configured": true
  }
}