GETlive

Read one webhook delivery and its attempts

Read one webhook delivery and its attempts.

/api/v2/webhooks/deliveries/{deliveryId}getWebhookDeliveryV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

Parameters

NameLocationRequirementSchema
deliveryIdpathRequired{"type":"string"}

Responses

200

Delivery and immutable attempt history.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PartnerWebhookDelivery",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "eventId",
        "deliveryId",
        "sequence",
        "caseId",
        "type",
        "occurredAt",
        "status",
        "attempts",
        "deliveryAttempts"
      ],
      "properties": {
        "eventId": {
          "type": "string"
        },
        "deliveryId": {
          "type": "string"
        },
        "sequence": {
          "type": "integer",
          "minimum": 1
        },
        "caseId": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "occurredAt": {
          "type": "string",
          "format": "date-time"
        },
        "endpointId": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "sending",
            "delivered",
            "failed",
            "suppressed",
            "dead_letter"
          ]
        },
        "attempts": {
          "type": "integer",
          "minimum": 0
        },
        "nextAttemptAt": {
          "type": "string",
          "format": "date-time"
        },
        "deadLetteredAt": {
          "type": "string",
          "format": "date-time"
        },
        "replayOfDeliveryId": {
          "type": "string"
        },
        "deliveredAt": {
          "type": "string",
          "format": "date-time"
        },
        "lastError": {
          "type": "string"
        },
        "deliveryAttempts": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PartnerWebhookDeliveryAttempt",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "attemptNumber",
              "status",
              "keyId",
              "signedAt"
            ],
            "properties": {
              "attemptNumber": {
                "type": "integer",
                "minimum": 1
              },
              "status": {
                "type": "string",
                "enum": [
                  "prepared",
                  "delivered",
                  "retryable_failure",
                  "terminal_failure"
                ]
              },
              "responseStatus": {
                "type": "integer"
              },
              "errorCode": {
                "type": "string"
              },
              "keyId": {
                "type": "string"
              },
              "signedAt": {
                "type": "string",
                "format": "date-time"
              },
              "completedAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "eventId": "event_test_123",
    "deliveryId": "delivery_test_123",
    "sequence": 1,
    "caseId": "case_test_123",
    "type": "type_test",
    "occurredAt": "2026-08-09T12:00:00.000Z",
    "status": "pending",
    "attempts": 1,
    "deliveryAttempts": [
      {
        "attemptNumber": 1,
        "status": "prepared",
        "keyId": "keyId_test",
        "signedAt": "2026-08-09T12:00:00.000Z"
      }
    ]
  },
  "requestId": "requestId_test"
}

Usage notes

  • Responses reflect the current authoritative resource state.