WebhookSubscriptionUpdateRequest

entityWebhookEntity (string)

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>

Nova URL HTTPS pública de retorno para entregas futuras.

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

auth object

Configuração opcional de autenticação de saída enviada nas entregas de webhook.

typeWebhookAuthType (string)obrigatório

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

Exemplo API_KEY

loginstring

Username for BASIC or API-key header name. Required for BASIC and API_KEY. API-key header names must be valid HTTP field names and cannot replace Authorization, transport headers, or Destrava signature headers.

Exemplo X-Webhook-Key

WebhookSubscriptionUpdateRequest

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