WebhookDelivery

eventIdstring<uuid>obrigatório

Identificador estável da entrega ou do evento. O reprocessamento preserva esse identificador.

Exemplo 99999999-9999-9999-9999-999999999999

eventTypenotifications_WebhookEntity (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

statusWebhookDeliveryStatus (string)obrigatório

Valores possíveis: [PENDING, IN_PROGRESS, DELIVERED, FAILED, CANCELLED]

Exemplo FAILED

eventStatusstringobrigatório

Status de negócio associado ao evento de origem, quando disponível.

Exemplo FAILED

attemptsintegerobrigatório

Valores possíveis: >= 0

Exemplo 3

maxAttemptsintegerobrigatório

Valores possíveis: >= 1

Exemplo 5

lastHttpStatusinteger

Exemplo 500

lastErrorstring

Trecho do último erro ocultado e truncado.

Exemplo upstream returned 500

eventOccurredAtstring<date-time>obrigatório

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

nextRetryAtstring<date-time>aceita valor nulo

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

deliveredAtstring<date-time>aceita valor nulo

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

createdAtstring<date-time>obrigatório

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

updatedAtstring<date-time>obrigatório

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

payloadstringobrigatório

Trecho do payload ocultado e truncado para exibição na interface.

Exemplo {"eventId":"99999999-9999-9999-9999-999999999999","payload":{"token":"[REDACTED]"}}

responsestring

Trecho da resposta final ocultado e truncado.

Exemplo {"message":"temporary failure"}

attemptHistory object[]

Lista [

attemptNumberintegerobrigatório

Valores possíveis: >= 1

Exemplo 2

webhookUrlstring<uri>obrigatório

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

payloadstring

Trecho do corpo da solicitação ocultado e truncado. Chaves sensíveis são substituídas por [REDACTED].

Exemplo {"eventId":"99999999-9999-9999-9999-999999999999","secret":"[REDACTED]"}

responseStatusinteger

Exemplo 500

responseBodystring

Trecho da resposta do provedor ocultado e truncado.

Exemplo {"message":"temporary failure"}

errorMessagestring

Trecho do erro ocultado e truncado.

Exemplo timeout waiting for response

durationMsinteger<int64>obrigatório

Valores possíveis: >= 0

Exemplo 842

successfulbooleanobrigatório

Exemplo false

attemptedAtstring<date-time>obrigatório

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

]

WebhookDelivery

{
  "eventId": "99999999-9999-9999-9999-999999999999",
  "eventType": "COLLECTION_CONTRACT",
  "status": "FAILED",
  "eventStatus": "FAILED",
  "attempts": 3,
  "maxAttempts": 5,
  "lastHttpStatus": 500,
  "lastError": "upstream returned 500",
  "eventOccurredAt": "2026-06-17T12:00:00Z",
  "nextRetryAt": "2026-06-17T12:15:00Z",
  "deliveredAt": "2026-06-17T12:06:00Z",
  "createdAt": "2026-06-17T12:00:10Z",
  "updatedAt": "2026-06-17T12:05:00Z",
  "payload": "{\"eventId\":\"99999999-9999-9999-9999-999999999999\",\"payload\":{\"token\":\"[REDACTED]\"}}",
  "response": "{\"message\":\"temporary failure\"}",
  "attemptHistory": [
    {
      "attemptNumber": 2,
      "webhookUrl": "https://example.com/destrava/webhooks",
      "payload": "{\"eventId\":\"99999999-9999-9999-9999-999999999999\",\"secret\":\"[REDACTED]\"}",
      "responseStatus": 500,
      "responseBody": "{\"message\":\"temporary failure\"}",
      "errorMessage": "timeout waiting for response",
      "durationMs": 842,
      "successful": false,
      "attemptedAt": "2026-06-17T12:05:00Z"
    }
  ]
}