List Webhooks API Reference

Serverhttps://api.pinnacle.sh/

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

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageIndexintegerOptional

Range

0 <= value

Default

pageSizeintegerOptional

Range

1 <= value <= 100

Default

statusstringOptional

Allowed values

"DISABLED""ENABLED""DELETED"

endpointstringOptional

Filter webhooks by endpoint URL (partial match, case-insensitive).

Example

"https://example.com/webhooks/messages"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.webhooks.list();

Responses

{  "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}

List Webhooks

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Webhooks

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`