How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CircleCI

CircleCI Webhooks

CircleCI Webhooks allow developers to receive real-time notifications about events in their CI/CD pipelines by configuring HTTP callbacks. Webhooks can be set up through project settings to notify external services when workflows and jobs complete, fail, or change status. This enables integration with monitoring systems, chat platforms, and custom automation workflows. Webhooks deliver JSON payloads containing event details to configured endpoint URLs.

Documentation Provider Profile APIs.io AsyncAPI GitHub

CircleCI Webhooks is one of 18 APIs that CircleCI publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include CI/CD, Event, Notification, and Webhook. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 1 operation across 1 channel, and defines 10 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, {webhookUrl} (https).

1 operations 1 channels 10 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Base URL
https://api.example.com
Contact
CircleCI Support
License
MIT
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
PUB
/webhook
Receive CircleCI webhook events
receiveCircleCIWebhook body

Messages & Schemas 10

The contract defines 10 schemas that model the data carried by its messages. The most detailed are JobCompletedPayload (9 properties), WorkflowCompletedPayload (8 properties), JobReference (6 properties), WorkflowReference (6 properties). Each schema is shown below with its type and property counts.

WorkflowCompleted
message
Fired when all jobs in a workflow have finished running.
JobCompleted
message
Fired when all steps in a job have completed.
WorkflowCompletedPayload
object
8 properties 8 required
JobCompletedPayload
object
9 properties 9 required
WebhookReference
object
Reference to the webhook subscription that generated this delivery
2 properties
ProjectReference
object
The project associated with the event
3 properties
OrganizationReference
object
The organization that owns the project
2 properties
WorkflowReference
object
The workflow associated with the event
6 properties
JobReference
object
The job associated with the event
6 properties
PipelineReference
object
The pipeline associated with the event
5 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

circleci-webhooks-asyncapi.yml Raw ↑

Other APIs CircleCI publishes across the network.

CircleCI Self-Hosted Runner API
AE Profile APIs.io
CircleCI Orbs Registry
AE Profile APIs.io
CircleCI Artifact API
AE Profile APIs.io
CircleCI Build API
AE Profile APIs.io
CircleCI Context API
AE Profile APIs.io
CircleCI Insights API
AE Profile APIs.io
CircleCI Job API
AE Profile APIs.io
CircleCI Pipeline API
AE Profile APIs.io
CircleCI Project API
AE Profile APIs.io
CircleCI Resource Class API
AE Profile APIs.io
CircleCI Runner Task API
AE Profile APIs.io
CircleCI Schedule API
AE Profile APIs.io
#CI/CD#Event#Notification#Webhook
← Back to C APIs
API Details
ID
circleci:webhooks
Base URL
https://api.example.com
Docs
https://circleci.com/docs/webhooks/
Provider
CircleCI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=webhooks-4&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/webhooks-4"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of CircleCI Webhooks, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.