GETlive

List tenant-scoped webhook deliveries

List tenant-scoped webhook deliveries. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped.

/api/webhooks/deliverieslistWebhookDeliveries

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
statusqueryOptional{"type":"string","enum":["pending","sending","delivered","failed","suppressed","dead_letter"]}
limitqueryOptional{"type":"integer","minimum":1,"maximum":200,"default":100}

Responses

200

Tenant-scoped delivery history.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "schemaVersion",
        "deliveries"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "partner-webhook-delivery-list-v2"
        },
        "deliveries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PartnerWebhookDelivery",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "eventId",
              "deliveryId",
              "sequence",
              "caseId",
              "type",
              "occurredAt",
              "status",
              "attempts",
              "deliveryAttempts"
            ],
            "properties": {
              "caseEvent": {
                "$ref": "#/components/schemas/CanonicalCaseEvent",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "id",
                  "cursor",
                  "type",
                  "occurredAt"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "string",
                    "const": "case-event-v1"
                  },
                  "id": {
                    "type": "string"
                  },
                  "cursor": {
                    "type": "string",
                    "description": "Opaque audit ID identifying a monotonically advancing committed per-case position. Never interpret or compare cursor text."
                  },
                  "type": {
                    "type": "string"
                  },
                  "occurredAt": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              },
              "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": {
    "schemaVersion": "partner-webhook-delivery-list-v2",
    "deliveries": [
      {
        "eventId": "event_test_123",
        "deliveryId": "delivery_test_123",
        "sequence": 1,
        "caseId": "pcase_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"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.