Webhook

Create an outbound webhook

Creates an outbound webhook for the given scope.

post/webhook

Request

Base URL
https://circleci.com/api/v2
URL
https://circleci.com/api/v2/webhook
Auth
- API key in header Circle-Token
- or HTTP bearer
- or HTTP basic
- or API key in query parameter circle-token

Request body

namestring required

Name of the webhook.

eventsstring[] required

Events that will trigger the webhook.

urlstring required

URL to deliver the webhook to. Note: protocol must be included as well (only https is supported).

verify-tlsboolean required

Whether to enforce TLS certificate verification when delivering the webhook.

signing-secretstring required

Secret used to build an HMAC hash of the payload and passed as a header in the webhook request.

Example request

{
  "name": "my-webhook",
  "events": [
    "workflow-completed",
    "job-completed"
  ],
  "url": "https://example.com/hooks/circleci",
  "verify-tls": true,
  "signing-secret": "super-secret-value",
  "scope": {
    "id": "39723015-b399-4601-9ff6-bd1bfbed8fa8",
    "type": "project"
  }
}

Response

A webhook.

idstring uuid required

The unique ID of the webhook.

namestring required

Name of the webhook.

urlstring required

URL to deliver the webhook to. Note: protocol must be included as well (only https is supported).

verify_tlsboolean required

Whether to enforce TLS certificate verification when delivering the webhook.

signing_secretstring required

Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request.

eventsstring[] required

Events that will trigger the webhook.

created_atstring date-time required

The date and time the webhook was created.

updated_atstring date-time required

The date and time the webhook was last updated.

Example response

{
  "id": "8d75ff3a-2b45-4d6e-9f1b-3c1e6f2a7b90",
  "name": "my-webhook",
  "url": "https://example.com/hooks/circleci",
  "verify_tls": true,
  "signing_secret": "********",
  "events": [
    "workflow-completed",
    "job-completed"
  ],
  "scope": {
    "id": "39723015-b399-4601-9ff6-bd1bfbed8fa8",
    "type": "project"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.