v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB
Webhook

List webhooks

Get a list of outbound webhooks that match the given scope-type and scope-id.

get/webhook

Query parameters

scope-idstring uuid required

ID of the scope being used (at the moment, only project ID is supported).

scope-type'project' required

Type of the scope being used (at the moment, only project is supported).

Response

A list of webhooks.

next_page_tokenstring nullable required

A token to pass as a page-token query parameter to return the next page of results.

Example response

{
  "items": [
    {
      "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"
      }
    }
  ]
}