Pular para o conteúdo principal

WebhookSubscriptionResponse

subscriptionIdstringobrigatório

Valores possíveis: não vazio

Exemplo 2w3Y2QeS0TtV3X9nZ5aBcD1eF6g
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
Exemplo https://example.com/destrava/webhooks
activebooleanobrigatório
Exemplo true
statusWebhookSubscriptionStatus (string)obrigatório

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

Exemplo ACTIVE
signatureSecretConfiguredbooleanobrigatório

Whether a signature secret is stored encrypted.

Exemplo true
auth object
typeWebhookAuthType (string)obrigatório

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

Exemplo BEARER
loginstring
Exemplo X-Client-Webhook-Key
configuredbooleanobrigatório

Whether an encrypted authentication secret is configured.

Exemplo true
createdAtstring<date-time>obrigatório
updatedAtstring<date-time>obrigatório
WebhookSubscriptionResponse
{
  "subscriptionId": "2w3Y2QeS0TtV3X9nZ5aBcD1eF6g",
  "entity": "COLLECTION_CONTRACT",
  "webhookUrl": "https://example.com/destrava/webhooks",
  "active": true,
  "status": "ACTIVE",
  "signatureSecretConfigured": true,
  "auth": {
    "type": "BEARER",
    "login": "X-Client-Webhook-Key",
    "configured": true
  },
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}