List webhook endpoints JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookEndpoints response 200",
  "description": "API response containing your webhook delivery endpoints.",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "A delivery destination. The signing secret is not part of this shape: it is returned once when the endpoint is created and again when it is rotated, and never on a list.",
        "type": "object",
        "required": [
          "consecutive_failures",
          "created_at",
          "description",
          "id",
          "status",
          "url"
        ],
        "properties": {
          "consecutive_failures": {
            "description": "Failed attempts since the last success. Resets to zero on a delivery that lands.",
            "type": "integer",
            "format": "int32",
            "example": 0
          },
          "created_at": {
            "description": "When the endpoint was created.",
            "type": "string",
            "format": "date-time"
          },
          "description": {
            "description": "Your own label for the endpoint.",
            "type": "string",
            "example": "Trading desk alerts"
          },
          "id": {
            "description": "Endpoint identifier.",
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "description": "`active` is serving. `disabled` means you switched it off. `auto_disabled` means a long run of failed deliveries switched it off for you; bring it back with the enable route.",
            "type": "string",
            "enum": [
              "active",
              "disabled",
              "auto_disabled"
            ],
            "example": "active"
          },
          "url": {
            "description": "HTTPS destination that receives deliveries.",
            "type": "string",
            "format": "uri",
            "example": "https://example.com/hooks/0xarchive"
          }
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookEndpoints 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"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "listWebhookEndpoints 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"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

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