List webhook endpoints (portal session)

GET

/api/webhooks

curl --request GET \
  --url https://api.sipstack.com/api/webhooks \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.sipstack.com/api/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/webhooks',
  headers: {Authorization: 'Bearer <token>'}
};

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

Portal admin-console surface, authenticated with the portal session (JWT/cookie). For server-to-server API-key access see the Webhooks (API key) tag.

Authorizations

bearerAuth

Responses

200

All webhook endpoints for your organization (signing secrets are never included).

application/json

object

success

boolean

data

Array<object>

object

integer

uuid

string format: uuid

url

string

events

Subscribed event types; ["*"] subscribes to everything. See Webhooks for the event catalog.

Array<string>

is_active

Endpoints are disabled automatically after 10 consecutive failed deliveries.

boolean

last_triggered_at

string format: date-time

nullable

failure_count

integer

created_at

string format: date-time

Example

{
  "data": [
    {
      "url": "https://example.com/sipstack-webhook",
      "events": [
        "message.delivered",
        "message.failed"
      ]
    }
  ]
}

401

Not authenticated.

403

Missing permission.