---
title: "List your webhooks"
method: GET
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# List your webhooks

`GET /v1/webhooks`

Returns every webhook on the team. Webhooks fire when a test finishes; use `failure_only`, `alert_types` and `name_filter` to narrow which tests trigger a delivery. The signing secret is never returned here — it is shown once when the webhook is created or its secret is rotated.

## Query parameters

- `offset` integer
- `count` integer

## Response `200`

List your webhooks

- TestingbotEntitiesWebhookList — Testingbot_Entities_WebhookList model
  - `data` TestingbotEntitiesWebhook[], required — Webhooks on this team.
    - `id` integer, required — Unique numeric webhook ID.
    - `name` string, required — Label for the webhook, shown on the dashboard.
    - `url` string, required — Destination URL. May contain `{{VARIABLES}}`, which are substituted at delivery time.
    - `http_method` string, required — HTTP method used to deliver: POST, PUT or PATCH.
    - `failure_only` boolean, required — When true, only failed tests trigger a delivery.
    - `alert_types` string, required — Which grid the test ran on: ALL, VIRTUAL (VM) or REAL (physical device).
    - `name_filter` string, required — Glob matched against the test name, falling back to the build identifier. Empty means every test.
    - `auth_type` string, required — How the request authenticates against your endpoint: NONE, BASIC or BEARER. The credentials themselves are never returned.
    - `headers` object[], required — Custom request headers, each `{ "key": ..., "value": ... }`. Values support `{{VARIABLES}}`.
    - `params` object[], required — Custom query parameters appended to the URL, each `{ "key": ..., "value": ... }`.
    - `payload_template` string, required — Custom JSON body template. Empty means the default TestingBot payload is sent.
    - `created_at` string, date-time, required — When the webhook was created.
    - `updated_at` string, date-time, required — When the webhook was last changed.
    - `signing_secret` string, required — Secret used to verify the `X-TestingBot-Signature` header. Only present when the webhook is created or its secret is rotated; store it then, because it is never returned again.
  - `meta` TestingbotEntitiesMeta, required
    - `offset` integer, required — Number of items skipped from the start of the result set.
    - `count` integer, required — Items returned in this page (matches the requested `count` query param).
    - `total` integer, required — Total number of items available across all pages.

## Other responses

- `401` — Authentication required
- `403` — Your role does not permit this action

---

[API](https://skmtc.net/testingbot/apis/testingbot-rest-api.md) · [All operations](https://skmtc.net/testingbot/apis/testingbot-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/testingbot/testingbot-rest-api/versions/eff607a49246/schema)
