---
title: "List webhooks"
method: GET
path: "/webhook"
tags: ["Webhook"]
---

# List webhooks

`GET /webhook`

## Request

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

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

## Query parameters

- `scope-id` string, uuid, required
- `scope-type` 'project', required

## Response `200`

A list of webhooks.

- WebhookList
  - `items` Webhook[], required
    - `id` string, uuid, required: The unique ID of the webhook.
    - `name` string, required: Name of the webhook.
    - `url` string, required: URL to deliver the webhook to. Note: protocol must be included as well (only https is supported).
    - `verify_tls` boolean, required: Whether to enforce TLS certificate verification when delivering the webhook.
    - `signing_secret` string, required: Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request.
    - `events` string[], required: Events that will trigger the webhook.
    - `scope` WebhookScope, required: The scope in which the relevant events that will trigger webhooks.
      - `id` string, uuid, required: ID of the scope being used (at the moment, only project ID is supported).
      - `type` string, required: Type of the scope being used.
    - `created_at` string, date-time, required: The date and time the webhook was created.
    - `updated_at` string, date-time, required: The date and time the webhook was last updated.
  - `next_page_token` string, nullable, required: A token to pass as a `page-token` query parameter to return the next page of results.

## Other responses

- `400`: Unexpected request body provided.
- `404`: Entity not found.
- `500`: Internal server error.

---

[API](https://skmtc.dev/circleci/apis/circleci-api.md) - [All operations](https://skmtc.dev/circleci/apis/circleci-api/llms.txt) - [OpenAPI document](https://skmtc.dev/circleci/apis/circleci-api/revisions/b9c0e0c24058?raw)