List deliveries for an endpoint JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookDeliveries path parameters",
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "description": "Endpoint identifier.",
      "type": "string",
      "format": "uuid",
      "example": "3c1f0a52-8d6b-4f0e-9b1a-6f2c4d8e9a10",
      "x-parameter-location": "path"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookDeliveries query parameters",
  "type": "object",
  "properties": {
    "limit": {
      "description": "Deliveries to return, newest first. Values outside the range are clamped to it.",
      "type": "integer",
      "format": "int64",
      "default": 50,
      "minimum": 1,
      "maximum": 200,
      "x-parameter-location": "query"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookDeliveries response 200",
  "description": "API response containing an endpoint's delivery log.",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "One delivery attempt record for one event to one endpoint. An event and an endpoint share a single row for their whole life, so a repeat delivery rewrites this record rather than adding another.",
        "type": "object",
        "required": [
          "attempts",
          "created_at",
          "event_id",
          "event_type",
          "id",
          "next_attempt_at",
          "payload",
          "state"
        ],
        "properties": {
          "attempts": {
            "description": "Attempts made so far.",
            "type": "integer",
            "format": "int32",
            "example": 1
          },
          "created_at": {
            "description": "When the delivery was queued. A repeat delivery resets this to the moment it was requested.",
            "type": "string",
            "format": "date-time"
          },
          "delivered_at": {
            "description": "When the delivery landed. Null until it does.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "event_id": {
            "description": "Event identifier, stable across retries and repeat deliveries. Deduplicate on this in your receiver.",
            "type": "string",
            "format": "uuid"
          },
          "event_type": {
            "description": "Event type delivered.",
            "type": "string",
            "example": "market.liquidation"
          },
          "id": {
            "description": "Delivery identifier.",
            "type": "string",
            "format": "uuid"
          },
          "last_error": {
            "description": "Why the last attempt failed. Null when it succeeded.",
            "type": "string",
            "nullable": true
          },
          "last_latency_ms": {
            "description": "How long the last attempt took, in milliseconds.",
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "example": 142
          },
          "last_status_code": {
            "description": "HTTP status your receiver returned on the last attempt.",
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "example": 200
          },
          "next_attempt_at": {
            "description": "When the next attempt is due.",
            "type": "string",
            "format": "date-time"
          },
          "payload": {
            "description": "The event body as sent, including its `id`, `type`, `schema_version`, `observed_at` and `data`.",
            "type": "object",
            "additionalProperties": true
          },
          "state": {
            "description": "`pending` is queued or waiting to retry, `delivered` landed, `failed` is the last attempt's result, and `exhausted` means the retry window closed without success.",
            "type": "string",
            "enum": [
              "pending",
              "delivered",
              "failed",
              "exhausted"
            ],
            "example": "delivered"
          }
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookDeliveries response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookDeliveries response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookDeliveries response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}