Cycles

Appearance

List delivery attempts for a tenant's webhook​

GET
/v1/webhooks/{subscription_id}/deliveries

Returns delivery history with status, response codes, and error details. Supports filtering by status and date range.
TENANCY:

  • Under ApiKeyAuth: 404 on cross-tenant subscription.
  • Under AdminKeyAuth: owning tenant resolved from
    the subscription record. Primary ops use case is diagnosing
    which specific delivery failures tripped the auto-disable
    threshold (drill down from the PATCH pause flow).

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​

Path Parameters

subscription_id*
Type
string
Required

Query Parameters

status
Type
string
Valid values
"PENDING""SUCCESS""FAILED""RETRYING"
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​

Delivery list

application/json
JSON
{
  
"deliveries": [
  
  
{
  
  
  
"delivery_id": "string",
  
  
  
"subscription_id": "string",
  
  
  
"event_id": "string",
  
  
  
"event_type": "string",
  
  
  
"status": "string",
  
  
  
"attempted_at": "string",
  
  
  
"completed_at": "string",
  
  
  
"attempts": 0,
  
  
  
"response_status": 0,
  
  
  
"response_time_ms": 0,
  
  
  
"error_message": "string",
  
  
  
"next_retry_at": "string",
  
  
  
"trace_id": "string",
  
  
  
"trace_flags": "string",
  
  
  
"traceparent_inbound_valid": true
  
  
}
  
],
  
"next_cursor": "string",
  
"has_more": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI