WebhookSubscriptionResponse

subscriptionIdstringobrigatório

Exemplo sub_01HZY7E6R4G7Z2M6D3T0Q9X4K5

entityWebhookEntity (string)obrigatório

Valores possíveis: [OPT_IN_CREATED, OPT_IN_RECURRENCE_UPDATED, SCHEDULE_ACCESS_REQUEST, COLLECTION_CONTRACT_CREATION, COLLECTION_CONTRACT, COLLATERALIZED_CREDIT_CONTRACT, COLLATERALIZED_CREDIT_ESCROW_ACCOUNT]

Exemplo COLLECTION_CONTRACT

webhookUrlstring<uri>obrigatório

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

activebooleanobrigatório

Indicador de compatibilidade para elegibilidade da entrega. Prefira status para representar o estado na interface.

Exemplo true

statusWebhookSubscriptionStatus (string)obrigatório

Entregas ACTIVE são elegíveis, PAUSED mantém a configuração sem novas entregas e DEACTIVATED representa a remoção lógica com o histórico preservado.

Valores possíveis: [ACTIVE, PAUSED, DEACTIVATED]

Exemplo ACTIVE

signatureSecretConfiguredbooleanobrigatório

Verdadeiro quando há um segredo de assinatura HMAC configurado; o segredo original nunca é retornado.

Exemplo true

createdAtstring<date-time>obrigatório

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

updatedAtstring<date-time>obrigatório

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

auth object

typeWebhookAuthType (string)obrigatório

Valores possíveis: [BASIC, BEARER, API_KEY]

Exemplo API_KEY

loginstring

Identificador público de autenticação. O valor secreto nunca é retornado.

Exemplo X-Webhook-Key

configuredbooleanobrigatório

Verdadeiro quando há um segredo de autenticação de saída configurado.

Exemplo 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
  }
}