> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pinnacle.sh/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server.

# List Webhooks

POST https://api.pinnacle.sh/webhooks/list
Content-Type: application/json

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

Reference: https://docs.pinnacle.sh/api-reference/webhooks/list

## Authentication

- `PINNACLE-API-KEY` header (required) — API Key authentication via header

## Request

### Body (application/json)

This endpoint expects a ListWebhooksRequest.

- `pageIndex` (integer, optional, default: 0)
- `pageSize` (integer, optional, default: 20)
- `status` (enum, optional)
  - Allowed values: `DISABLED`, `ENABLED`, `DELETED`
- `endpoint` (string, optional) — Filter webhooks by endpoint URL (partial match, case-insensitive).

## Response

### 200

Returns paginated list of webhooks.

- `data` (list of WebhookSummary, required)
- `hasMore` (boolean, required)
- `count` (integer, required)

## Errors

### 400 Bad Request Error

Validation failed. The payload has missing required fields and/or invalid types.  See [https://zod.dev/error-formatting](https://zod.dev/error-formatting) for more information.

- `description` (string, required) — Human-readable summary of validation failures.
- `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### 401 Unauthorized Error

The request lacks valid authentication credentials or the provided credentials are invalid.  Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 500 Internal Server Error

An unexpected error occurred on Pinnacle's servers while processing your request.  If this error persists, please contact support with the request details.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

## Types

### WebhookSummary

- `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` (enum, required) — Current status of the webhook.
  - Allowed values: `DISABLED`, `ENABLED`, `DELETED`
- `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` (map from string to string, optional, 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.

### ZodErrorErrors

Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "data": [
    {
      "id": "wh_abc123",
      "name": "SMS Delivery Webhook",
      "endpoint": "https://example.com/webhooks/sms",
      "status": "ENABLED",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z",
      "headers": {
        "X-API-KEY": "sk_live_...",
        "X-TENANT-ID": "tenant_42"
      }
    },
    {
      "id": "wh_def456",
      "name": "RCS Events",
      "endpoint": "https://example.com/webhooks/rcs",
      "status": "ENABLED",
      "createdAt": "2025-01-10T08:00:00Z",
      "updatedAt": "2025-02-01T12:00:00Z",
      "headers": null
    }
  ],
  "hasMore": false,
  "count": 2
}
```

**SDK Code**

```python List Webhooks
import requests

url = "https://api.pinnacle.sh/webhooks/list"

payload = {}
headers = {
    "PINNACLE-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript List Webhooks
const url = 'https://api.pinnacle.sh/webhooks/list';
const options = {
  method: 'POST',
  headers: {'PINNACLE-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go List Webhooks
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinnacle.sh/webhooks/list"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("PINNACLE-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby List Webhooks
require 'uri'
require 'net/http'

url = URI("https://api.pinnacle.sh/webhooks/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["PINNACLE-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java List Webhooks
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.pinnacle.sh/webhooks/list")
  .header("PINNACLE-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php List Webhooks
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.pinnacle.sh/webhooks/list', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PINNACLE-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp List Webhooks
using RestSharp;

var client = new RestClient("https://api.pinnacle.sh/webhooks/list");
var request = new RestRequest(Method.POST);
request.AddHeader("PINNACLE-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift List Webhooks
import Foundation

let headers = [
  "PINNACLE-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/webhooks/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```