Outbound webhooks
Setting up an outbound webhook on CircleCI enables your third party service to receive information (referred to as events) from CircleCI, as they happen. This can help you avoid polling the API or manually checking the CircleCI web application for desired information.
Introduction
Use outbound webhooks to integrate your CircleCI builds with external services.
For example, you could use outbound webhooks to:
-
Build a custom dashboard to visualize or analyze workflow/job events.
-
Send data to incident management tools (such as PagerDuty).
-
Use tools like Airtable to capture data and visualize it.
-
Alert when a workflow is cancelled, then use the API to rerun the workflow.
-
Trigger notification systems to alert people when workflows/jobs complete.
-
Build your own automation plugins and tools.
The following sections detail CircleCI outbound webhook structure and protocols.
Quickstart
| Projects are limited to 5 outbound webhooks. Organization admin permissions are required to add, update, and delete outbound webhooks. |
Webhooks are set up on a per-project basis, either within the CircleCI app or via API.
To configure webhooks via API see our documentation for Webhooks Public API.
To configure webhooks within the CircleCI app:
-
In the CircleCI web app, select your org from the org cards on your user homepage.
-
Select Projects from the sidebar and locate your project from the list. You can use the search to help.
-
Select the ellipsis
next to your project and select Project Settings.
You can also access project settings from each project overview page using the Settings button. -
In the sidebar select Webhooks.
-
Select Add Webhook.
-
Fill out the webhook form (the table below describes the fields and their intent).
Figure 1. The Add Webhook form -
If your receiving API or third party service is set up, select Test Ping Event to send a test event.
The test ping event has an abbreviated payload for ease of testing. See full examples for Sample Webhook Payloads section of the webhooks reference.
| Field | Required? | Intent |
|---|---|---|
Webhook name |
Y |
The name of your webhook |
URL |
Y |
The URL the webhook will make POST requests to |
Certificate Validation |
Y |
Ensure the receiving host has a valid SSL certificate before sending an event. Only leave this unchecked for testing purposes. |
Secret token |
N |
Used by your API/platform to validate incoming data is from CircleCI |
Select an event |
Y |
You must select at least one event that will trigger a webhook |
Communication protocol for outbound webhooks
Once set up, a webhook is sent whenever an event occurs on the CircleCI platform.
A webhook is sent using an HTTP POST to the URL that was registered when the webhook was created, with a body encoded using JSON.
CircleCI expects the server that responds to a webhook will return a 2xx response code. If a non-2xx response is received, CircleCI will retry at a later time. If CircleCI does not receive a response to the webhook within a short period of time, CircleCI will assume that delivery has failed, and will retry at a later time. The timeout period is currently 10 seconds.
Webhook requests may be duplicated. To deduplicate (prevent requests from being duplicated for a specific event), use the ID Property in the webhook payload for identification.
Outbound webhook headers
A number of HTTP headers are set on webhooks, as detailed in the table below.
| Header name | Value |
|---|---|
|
|
|
A string indicating that the sender was CircleCI ( |
|
The type of event, ( |
|
When present, this signature can be used to verify that the sender of the webhook has access to the secret token. |
Validate outbound webhooks
Validate webhooks as they come in to third-party services to verify that they are coming from CircleCI. To support this, when creating a webhook, you can optionally provide a secret token. Each outgoing HTTP request to your service will contain a circleci-signature header. This header will consist of a comma-separated list of versioned signatures.
POST /uri HTTP/1.1
Host: your-webhook-host
circleci-signature: v1=4fcc06915b43d8a49aff193441e9e18654e6a27c2c428b02e8fcc41ccc2299f9,v2=...,v3=...
Currently, the latest (and only) signature version is v1. Only check the latest signature type to prevent downgrade attacks.
The v1 signature is the HMAC-SHA256 digest of the request body, using the configured signing secret as the secret key.
Here are some example signatures for given request bodies:
| Body | Secret Key | Signature |
|---|---|---|
|
|
|
|
|
|
|
|
|
The following is an example of how you might validate signatures in Python:
import hmac
def verify_signature(secret, headers, body):
# get the v1 signature from the `circleci-signature` header
signature_from_header = {
k: v for k, v in [
pair.split('=') for pair in headers['circleci-signature'].split(',')
]
}['v1']
# Run HMAC-SHA256 on the request body using the configured signing secret
valid_signature = hmac.new(bytes(secret, 'utf-8'), bytes(body, 'utf-8'), 'sha256').hexdigest()
# use constant time string comparison to prevent timing attacks
return hmac.compare_digest(valid_signature, signature_from_header)
# the following will return `True`
verify_signature(
'secret',
{
'circleci-signature': 'v1=773ba44693c7553d6ee20f61ea5d2757a9a4f4a44d2841ae4e95b52e4cd62db4'
},
'foo',
)
# the following will return `False`
verify_signature(
'secret',
{
'circleci-signature': 'v1=not-a-valid-signature'
},
'foo',
)
Outbound webhook event specifications
CircleCI currently offers outbound webhooks for the following events:
| Event type | Description | Potential status | Included sub-entities |
|---|---|---|---|
workflow-completed |
A workflow has reached a terminal state |
|
project, organization, workflow, pipeline |
job-completed |
A job has reached a terminal state |
|
project, organization, workflow, pipeline, job |
View outbound webhook deliveries
CircleCI keeps a record of each event it sends to a webhook. Use the record to check that your endpoint receives events, and to find out why an event was not delivered.
To view the deliveries of a webhook:
-
In the CircleCI web app, select your org from the org cards on your user homepage.
-
Select Projects from the sidebar and locate your project from the list. You can use the search to help.
-
Select the ellipsis
next to your project and select Project Settings.
You can also access project settings from each project overview page using the Settings button. -
In the sidebar select Webhooks.
-
In the row of the webhook, select View deliveries.
You can also select the name of the webhook to open its Settings tab, then select the Deliveries tab.
The list shows the most recent deliveries first. CircleCI keeps deliveries for 14 days. While the tab is open, the list refreshes every 30 seconds. Use the refresh controls above the list to refresh it yourself or to turn off the automatic refresh.
A delivery is one event sent to the webhook. When CircleCI retries an event, the retries belong to the same delivery. Test ping events show in the list with the event type Ping.
| Column | Description |
|---|---|
Time |
When CircleCI sent the event. |
Event type |
The event, for example Workflow Completed or Job Completed. |
Delivery |
The result of the delivery:
|
HTTP |
The HTTP status code of the last attempt. A dash means the endpoint did not respond. |
Attempts |
The number of attempts, including retries. |
Duration |
How long the last attempt took. |
To narrow the list, use the following filters:
-
Use the toggle to show either All events or just the events marked Not delivered.
-
Use the event type dropdown menu to choose between seeing all event types or just one.
-
Use the time range dropdown to show the last 24 hours, the last 7 days, or the last 14 days.
-
To find a specific delivery, enter its event ID in the Search by event ID field. The event ID is the
idkey in the webhook payload. For more information, see the Webhooks Reference.
View the details of a delivery
Select a delivery in the list to open its details. The details show the same information as the list, along with the following:
-
The event ID.
-
A link to the workflow the event is about. Test ping events have no workflow.
-
For a delivery that was not delivered, the reason it failed, for example a timeout, a failed TLS certificate check, or the HTTP status code the endpoint returned.
-
The request payload CircleCI sent. Select Copy JSON to copy it.
To list and view deliveries using the API, see the Webhook Deliveries API v3 Reference.
Next steps
-
See the Webhooks Reference page for key definitions and sample payloads.
-
Follow the Using Webhooks With Third Party Tools tutorial.