Cycles

Appearance

List webhooks for the authenticated tenant (or a specified tenant under admin auth)​

GET
/v1/webhooks

Returns webhook subscriptions scoped by the authenticated caller.
TENANCY (NORMATIVE):

  • Under ApiKeyAuth: results are scoped to the effective tenant
    derived from auth. The tenant query parameter MUST NOT be
    set (or, if accepted, is validation-only and MUST match the
    effective tenant).
  • Under AdminKeyAuth: admin has no effective
    tenant. The tenant query parameter is REQUIRED as a FILTER.
    Omitting it MUST return 400 INVALID_REQUEST with message
    "tenant query parameter is required when using admin key
    authentication". Same single-param dual-semantic pattern as
    listBudgets / listPolicies / listReservations.

PERMISSIONS: - ApiKeyAuth: requires webhooks:read permission on the API key. - AdminKeyAuth: no permission check beyond admin key validity.

Authorizations​

ApiKeyAuth

Tenant-scoped API key for runtime operations (consistent with Cycles Protocol)

Type
API Key (header: X-Cycles-API-Key)
or
AdminKeyAuth

Administrative API key with full system access. Also accepted as an alternative to ApiKeyAuth on an explicit per-operation allowlist — the authoritative list is the union of operations whose security: block declares AdminKeyAuth (consult per-operation security blocks rather than this prose, which has historically drifted as the dual-auth surface expanded). When using AdminKeyAuth on list or fund endpoints, a tenant scoping parameter (typically tenant or tenant_id) is required for scoping (400 if missing) — the per-operation description specifies which. Lookup-style endpoints that uniquely identify a resource by non-tenant key (e.g. GET /v1/admin/budgets/lookup, where the (scope, unit) pair is unique) do NOT require a tenant parameter. Allowlisting is per-operation (exact method:path matching — no prefix matching, no wildcards) so new endpoints do not accidentally inherit admin-accessible status.

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

Parameters​

Query Parameters

tenant

Under AdminKeyAuth: REQUIRED — specifies which tenant's webhooks to list. Under ApiKeyAuth: MUST NOT be set (the authenticated key's tenant is used).

Type
string
status
Type
string
Valid values
"ACTIVE""PAUSED""DISABLED"
cursor
Type
string
limit
Type
integer
Minimum
1
Maximum
100
Default
50

Responses​

Subscription list

application/json
JSON
{
  
"subscriptions": [
  
  
{
  
  
  
"subscription_id": "string",
  
  
  
"tenant_id": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"url": "string",
  
  
  
"event_types": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"event_categories": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"scope_filter": "string",
  
  
  
"thresholds": {
  
  
  
  
"budget_utilization": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"burn_rate_multiplier": 3,
  
  
  
  
"burn_rate_window_seconds": 300,
  
  
  
  
"denial_rate_threshold": 0.1,
  
  
  
  
"expiry_rate_threshold": 0.05,
  
  
  
  
"auth_failure_rate_threshold": 0.1,
  
  
  
  
"rate_window_seconds": 300
  
  
  
},
  
  
  
"signing_secret": "string",
  
  
  
"headers": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"status": "string",
  
  
  
"retry_policy": {
  
  
  
  
"max_retries": 5,
  
  
  
  
"initial_delay_ms": 1000,
  
  
  
  
"backoff_multiplier": 2,
  
  
  
  
"max_delay_ms": 60000
  
  
  
},
  
  
  
"disable_after_failures": 10,
  
  
  
"consecutive_failures": 0,
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string",
  
  
  
"last_triggered_at": "string",
  
  
  
"last_success_at": "string",
  
  
  
"last_failure_at": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
}
  
],
  
"next_cursor": "string",
  
"has_more": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI