CircleCI · Schema

WebhookInfo

CI/CDContinuous IntegrationContinuous DeploymentDevOpsPipelinesWorkflows

Properties

Name Type Description
id string The unique identifier of the webhook
url string The URL the webhook delivers to
name string The name of the webhook
events array The events this webhook subscribes to
scope object The scope of the webhook
signing-secret string The signing secret for verifying webhook payloads
verify-tls boolean Whether to verify TLS certificates
created-at string When the webhook was created
updated-at string When the webhook was last updated
View JSON Schema on GitHub

JSON Schema

circleci-webhookinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookInfo",
  "title": "WebhookInfo",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the webhook"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL the webhook delivers to"
    },
    "name": {
      "type": "string",
      "description": "The name of the webhook"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "workflow-completed",
          "job-completed"
        ]
      },
      "description": "The events this webhook subscribes to"
    },
    "scope": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The scope ID"
        },
        "type": {
          "type": "string",
          "description": "The scope type"
        }
      },
      "description": "The scope of the webhook"
    },
    "signing-secret": {
      "type": "string",
      "description": "The signing secret for verifying webhook payloads"
    },
    "verify-tls": {
      "type": "boolean",
      "description": "Whether to verify TLS certificates"
    },
    "created-at": {
      "type": "string",
      "format": "date-time",
      "description": "When the webhook was created"
    },
    "updated-at": {
      "type": "string",
      "format": "date-time",
      "description": "When the webhook was last updated"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/circleci-webhookinfo"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.