Cycles

Appearance

Send a test event to a tenant's webhook​

POST
/v1/webhooks/{subscription_id}/test

Sends a synthetic system.webhook_test event. Does not count toward consecutive failures.
TENANCY:

  • Under ApiKeyAuth: 404 on cross-tenant subscription.
  • Under AdminKeyAuth: owning tenant resolved from
    the subscription record. Primary ops use case is verifying
    that a paused/failing webhook is reachable after the tenant
    fixes their endpoint, before flipping status back to ACTIVE.

AUDIT: test events are not required to produce an audit entry under AdminKeyAuth (diagnostic, idempotent, non-state-mutating on the subscription itself); a delivery record is created as usual. Servers MAY still log for operational visibility.
PERMISSIONS: - ApiKeyAuth: requires webhooks:write 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​

Path Parameters

subscription_id*
Type
string
Required

Responses​

Test result

application/json
JSON
{
  
"success": true,
  
"response_status": 0,
  
"response_time_ms": 0,
  
"error_message": "string",
  
"event_id": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI