CircleCI · AsyncAPI Specification

CircleCI Webhooks

Version 1.0

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 or the API 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 via HTTP POST to configured endpoint URLs, signed with HMAC SHA256 for verification.

View Spec View on GitHub CI/CDContinuous IntegrationContinuous DeploymentDevOpsPipelinesWorkflowsAsyncAPIWebhooksEvents

Channels

/webhook

publish receiveCircleCIWebhook

Receive CircleCI webhook events

CircleCI delivers webhook events as HTTP POST requests with JSON payloads to the configured endpoint URL. Each delivery includes a circleci-signature header containing an HMAC SHA256 digest of the request body for verification.

Messages

✉

WorkflowCompleted

Workflow Completed Event

Fired when all jobs in a workflow have finished running.

✉

JobCompleted

Job Completed Event

Fired when all steps in a job have completed.

Servers

https

circleci {webhookUrl}

Your webhook endpoint URL. CircleCI sends HTTP POST requests to this URL when events occur. The URL is configured when creating a webhook subscription via project settings or the API.