WebhookSubscriptionCreateRequest

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

Public HTTPS callback URL. Localhost, private, link-local, metadata and ambiguous IP targets are rejected for SSRF protection.

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

auth object

Optional outbound authentication configuration sent with webhook deliveries.

typeWebhookAuthType (string)required

Possible values: [BASIC, BEARER, API_KEY]

Example: API_KEY

loginstring

Username, API-key header name, or other public auth identifier. Required for BASIC and API_KEY.

Example: X-Webhook-Key

WebhookSubscriptionCreateRequest

{
  "entity": "COLLECTION_CONTRACT",
  "webhookUrl": "https://example.com/destrava/webhooks",
  "auth": {
    "type": "API_KEY",
    "login": "X-Webhook-Key"
  }
}