List Webhook subscriptions

GET /v1/webhooks

Lists the subscriptions of the Organization, newest first, optionally by status (1.63.0) or, from 1.64.0, by an event type they select; each shows the hint of its secret, never the secret, and from 1.64.0 its newest delivery (last_delivery).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/webhooks" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/webhooks`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is WebhookSubscriptionList.