Pular para o conteúdo principal

WebhookSubscriptionCreateRequest

entityWebhookEntity (string)obrigatório

Valores possíveis: [SCHEDULE_ACCESS_REQUEST, COLLECTION_CONTRACT_CREATION, COLLECTION_CONTRACT, COLLATERALIZED_CREDIT_CONTRACT, COLLATERALIZED_CREDIT_ESCROW_ACCOUNT, AGENDA_CONSOLIDATED, NUCLEA_CONTRACT, NUCLEA_SCHEDULE_QUERY]

Exemplo COLLECTION_CONTRACT
webhookUrlstring<uri>obrigatório

Public HTTPS receiver URL. Private, loopback, localhost, and link-local targets are rejected.

Exemplo https://example.com/destrava/webhooks
auth object
typeWebhookAuthType (string)obrigatório

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

Exemplo BEARER
loginstring

Header name for API_KEY or username for BASIC.

Valores possíveis: não vazio

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