List Event Types - KnoxCall Docs

List Event Types

GET /v1/webhooks/event-types

Returns the set of event types you can subscribe to when creating a webhook. Useful for building event pickers in UIs and connectors (Zapier, Make, n8n use this to populate their event dropdowns).

Response

{
  "data": {
    "event_types": [
      { "value": "request.received",     "label": "Request > Received",     "description": "Triggered when a request is received" },
      { "value": "request.success",      "label": "Request > Success",      "description": "Triggered on a successful 2xx response" },
      { "value": "request.redirect",     "label": "Request > Redirect",     "description": "Triggered on a 3xx redirect response" },
      { "value": "request.client_error", "label": "Request > Client_error", "description": "Triggered on a 4xx client error" },
      { "value": "request.server_error", "label": "Request > Server_error", "description": "Triggered on a 5xx server error" },
      { "value": "request.timeout",      "label": "Request > Timeout",      "description": "Triggered when the request times out" },
      { "value": "request.error",        "label": "Request > Error",        "description": "Triggered on any error (non-2xx response)" },
      { "value": "request.completed",    "label": "Request > Completed",    "description": "Triggered on every completed request" },
      { "value": "audit.event",          "label": "Audit > Event",          "description": "Triggered on any audit-log entry (config changes, auth events) — for SIEM / observability streams" }
    ]
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}

The audit.event type streams every audit-log entry (config changes, auth events, rotations) to your webhook — ideal for SIEM/observability pipelines. Unlike the request.* events, it fires in both Live and Test modes.

import { KnoxCall } from "@knoxcall/sdk";

const client = new KnoxCall(); // credentials from `knoxcall login` or KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET

const { event_types } = await client.webhooks.listEventTypes();
console.log(event_types.map((e) => e.value));

from knoxcall import KnoxCall

client = KnoxCall()  # credentials from `knoxcall login` or KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET

data = client.webhooks.list_event_types()
print([e["value"] for e in data["event_types"]])

# Mint a 1-hour OAuth token (client_credentials) — see /api-reference/authentication
TOKEN=$(curl -s -X POST https://api.knoxcall.com/oauth/token \
  -u "$KNOXCALL_CLIENT_ID:$KNOXCALL_CLIENT_SECRET" \
  -d "grant_type=client_credentials" | jq -r .access_token)

curl https://api.knoxcall.com/v1/webhooks/event-types \
  -H "Authorization: Bearer $TOKEN"