Retrieve Webhooks | Pinnacle

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

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

identifierslist of stringsRequired

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

Limit: 1 min

Response

Returns all webhooks matching the search criteria.

Results are sorted by ID and duplicates are removed. This identifier is a string that always begins with the prefix wh_, for example: wh_1234567890.

webhookslist of objects

List of webhooks.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.webhooks.get({
8	identifiers: [
9	"https://www.pinnacle.sh/payment",
10	"+14155678901",
11	"https://www.pinnacle.sh/sms-callback",
12	"+14153456659",
13	],
14	});
15	}
16	main();

1	{
2	"webhooks": [
3	{
4	"endpoint": "https://www.pinnacle.sh/examples/check-payment",
5	"id": "wh_1234567890",
6	"name": "Payment Notification Webhook"
7	},
8	{
9	"endpoint": "https://www.pinnacle.sh/examples/talk-to-my-friends",
10	"id": "wh_1234567890",
11	"name": "SMS Delivery Webhook"
12	}
13	]
14	}

Authentication

Request

Response

Errors