Discover the webhook event catalog

GET

/api/v2/events

curl --request GET \
  --url https://api.sipstack.com/api/v2/events \
  --header 'x-api-key: <x-api-key>'

const url = 'https://api.sipstack.com/api/v2/events';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

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

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/v2/events',
  headers: {'x-api-key': '<x-api-key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Returns every event name a webhook endpoint may subscribe to, each with a human description, plus the * wildcard. Use it to build a subscription UI or validate event names before calling POST /api/v2/webhooks. API-key gated only (like /me) — not behind the webhooks plan gate.

Authorizations

apiKeyAuth

Responses

200

The event catalog.

application/json

The valid outbound-webhook event catalog, as returned by GET /api/v2/events.

object

success

boolean

data

object

events

Array<object>

object

name

string

description

string

wildcard

object

name

string

description

string

Example

{
  "success": true,
  "data": {
    "events": [
      {
        "name": "message.delivered",
        "description": "An outbound message was confirmed delivered to the handset."
      }
    ],
    "wildcard": {
      "name": "*",
      "description": "Subscribe to every event type, including ones added later."
    }
  }
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}