---
title: "List Webhooks"
method: POST
path: "/webhooks/list"
tags: ["Webhooks"]
---

# List Webhooks

`POST /webhooks/list`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/webhooks/list`
- Auth: API key in header `PINNACLE-API-KEY`

List all webhooks with optional filtering and pagination. Results are sorted by creation date, newest first.

## Request body

- ListWebhooksRequest
  - `pageIndex` integer
  - `pageSize` integer
  - `status` 'DISABLED' | 'ENABLED' | 'DELETED'
  - `endpoint` string: Filter webhooks by endpoint URL (partial match, case-insensitive).

## Response `200`

Returns paginated list of webhooks.

- ListWebhooksResponse
  - `data` WebhookSummary[], required
    - `id` string, required: Unique identifier of the webhook. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
    - `name` string, required: Name of the webhook.
    - `endpoint` string, required: URL where webhook events are delivered.
    - `status` 'DISABLED' | 'ENABLED' | 'DELETED', required: Current status of the webhook.
    - `createdAt` string, required: ISO 8601 timestamp of when the webhook was created.
    - `updatedAt` string, required: ISO 8601 timestamp of when the webhook was last updated.
    - `headers` object, nullable: Optional custom HTTP headers sent when dispatching webhook events. Header names must match the regex `^[A-Za-z0-9][A-Za-z0-9_-]*$` — start with a letter or digit and contain only letters, digits, `-`, or `_`. Keys are case-insensitive and stored in uppercase. Values must be strings. The reserved `PINNACLE-SIGNING-SECRET` header is never returned here and cannot be overridden.
  - `hasMore` boolean, required
  - `count` integer, required

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)