Pular para o conteúdo principal

WebhookDelivery

eventIdstring<uuid>required

Stable delivery/event identifier. Replay preserves this ID.

Example: 99999999-9999-9999-9999-999999999999
eventTypenotifications_WebhookEntity (string)required

Possible values: [OPT_IN_CREATED, OPT_IN_RECURRENCE_UPDATED, SCHEDULE_ACCESS_REQUEST, COLLECTION_CONTRACT_CREATION, COLLECTION_CONTRACT, COLLATERALIZED_CREDIT_CONTRACT, COLLATERALIZED_CREDIT_ESCROW_ACCOUNT]

Example: COLLECTION_CONTRACT
statusWebhookDeliveryStatus (string)required

Possible values: [PENDING, IN_PROGRESS, DELIVERED, FAILED, CANCELLED]

Example: FAILED
eventStatusstringrequired

Business status associated with the source event when available.

Example: FAILED
attemptsintegerrequired

Possible values: >= 0

Example: 3
maxAttemptsintegerrequired

Possible values: >= 1

Example: 5
lastHttpStatusinteger
Example: 500
lastErrorstring

Redacted and truncated last error excerpt.

Example: upstream returned 500
eventOccurredAtstring<date-time>required
Example: 2026-06-17T12:00:00Z
nextRetryAtstring<date-time>nullable
Example: 2026-06-17T12:15:00Z
deliveredAtstring<date-time>nullable
Example: 2026-06-17T12:06:00Z
createdAtstring<date-time>required
Example: 2026-06-17T12:00:10Z
updatedAtstring<date-time>required
Example: 2026-06-17T12:05:00Z
payloadstringrequired

Redacted and truncated payload excerpt for UI display.

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

Redacted and truncated final response excerpt.

Example: {"message":"temporary failure"}
attemptHistory object[]
  • Array [
  • attemptNumberintegerrequired

    Possible values: >= 1

    Example: 2
    webhookUrlstring<uri>required
    Example: https://example.com/destrava/webhooks
    payloadstring

    Redacted and truncated request body excerpt. Sensitive keys are replaced with [REDACTED].

    Example: {"eventId":"99999999-9999-9999-9999-999999999999","secret":"[REDACTED]"}
    responseStatusinteger
    Example: 500
    responseBodystring

    Redacted and truncated provider response excerpt.

    Example: {"message":"temporary failure"}
    errorMessagestring

    Redacted and truncated error excerpt.

    Example: timeout waiting for response
    durationMsinteger<int64>required

    Possible values: >= 0

    Example: 842
    successfulbooleanrequired
    Example: false
    attemptedAtstring<date-time>required
    Example: 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"
    }
    ]
    }