Query the event stream

GET

/v1/admin/events

Returns paginated events with filtering by type, category, tenant, scope, and time range. This is the canonical event log — all events that triggered (or would have triggered) webhooks are queryable here.
USE CASES: - Debug why a webhook fired (or didn't fire) - Reconstruct event history for a scope - Build custom integrations without webhooks (poll-based) - Audit trail supplement (events are more granular than audit logs)
RETENTION: - Same as audit log retention (recommended: 90 days hot, 1 year cold).

Authorizations

AdminKeyAuth

Administrative API key with full system access

Type

API Key (header: X-Admin-API-Key)

Parameters

Query Parameters

tenant_id

Type

string

event_type

Filter by specific event type

Type

string

Valid values

"budget.created""budget.updated""budget.funded""budget.debited""budget.reset""budget.debt_repaid""budget.frozen""budget.unfrozen""budget.closed""budget.threshold_crossed""budget.exhausted""budget.over_limit_entered""budget.over_limit_exited""budget.debt_incurred""budget.burn_rate_anomaly""reservation.denied""reservation.denial_rate_spike""reservation.expired""reservation.expiry_rate_spike""reservation.commit_overage""tenant.created""tenant.updated""tenant.suspended""tenant.reactivated""tenant.closed""tenant.settings_changed""api_key.created""api_key.revoked""api_key.expired""api_key.permissions_changed""api_key.auth_failed""api_key.auth_failure_rate_spike""policy.created""policy.updated""policy.deleted""system.store_connection_lost""system.store_connection_restored""system.high_latency""system.webhook_delivery_failed""system.webhook_test"

category

Filter by event category

Type

string

Valid values

"budget""tenant""api_key""policy""reservation""system"

scope

Filter by scope path (prefix match)

Type

string

correlation_id

Filter by correlation ID to find related events

Type

string

from

Type

string

Format

"date-time"

to

Type

string

Format

"date-time"

cursor

Type

string

limit

Type

integer

Minimum

1

Maximum

100

Default

50

Responses

Event list

Content-Type

application/json

{

  

"events": [

  

  

{

  

  

  

"event_id": "string",

  

  

  

"event_type": "string",

  

  

  

"category": "string",

  

  

  

"timestamp": "string",

  

  

  

"tenant_id": "string",

  

  

  

"scope": "string",

  

  

  

"actor": {

  

  

  

  

"type": "string",

  

  

  

  

"key_id": "string",

  

  

  

  

"source_ip": "string"

  

  

  

},

  

  

  

"source": "string",

  

  

  

"data": {

  

  

  

  

"additionalProperties": "string"

  

  

  

},

  

  

  

"correlation_id": "string",

  

  

  

"request_id": "string",

  

  

  

"metadata": {

  

  

  

  

"additionalProperties": "string"

  

  

  

}

  

  

}

  

],

  

"next_cursor": "string",

  

"has_more": true

}

GET

/v1/admin/events

Playground

Authorization

AdminKeyAuth

Variables

Key

Value

tenant_id

event_type

category

scope

correlation_id

from

to

cursor

limit

Samples

Powered by VitePress OpenAPI