Pular para o conteúdo principal

WebhookSubscriptionCreateRequest

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

URL HTTPS pública de retorno. Destinos locais, privados, link-local, de metadados ou com IP ambíguo são rejeitados para proteção contra SSRF.

Exemplo https://example.com/destrava/webhooks
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

Nome de usuário, nome do cabeçalho da chave de API ou outro identificador público de autenticação. Obrigatório para BASIC e API_KEY.

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