Retrieve Webhooks API Reference

Serverhttps://api.pinnacle.sh/

Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

identifiersarray<string>

List of URLs or phone numbers in E.164 format that the webhook is attached to.

Limit: 1 min

Items

1 <= items

Each item

Example

"resource_01J8K3R7M9"

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.get({
    identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"]
});

Responses

{  "webhooks": [    {      "id": "wh_1234567890",      "name": "Payment Notification Webhook",      "endpoint": "https://www.pinnacle.sh/examples/check-payment",      "headers": {        "X-API-KEY": "sk_live_..."      }    },    {      "id": "wh_1234567890",      "name": "SMS Delivery Webhook",      "endpoint": "https://www.pinnacle.sh/examples/talk-to-my-friends",      "headers": null    }  ]}

Retrieve Webhooks

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Retrieve Webhooks

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`