Archive API docs

Object

WebhookSubscription

An outbound-webhook subscription for the current workspace. The signing secret is returned only from createWebhookSubscription / rotateWebhookSubscriptionSecret and is never exposed on this type.

Fields

consecutiveFailures Int!
Consecutive failed deliveries since the last success — a health signal; resets to 0 on the next successful delivery.
createdAt DateTimeWithZone!
When the subscription was created.
disabledAt DateTimeWithZone
When the subscription was disabled by failures. Null while active/paused.
eventTypes [String!]!
Event types this subscription matches (e.g. content_view.item_added).
id ID!
Unique identifier of the subscription.
lastSuccessAt DateTimeWithZone
When the most recent successful delivery occurred. Null if none yet.
metadata JSON!
Opaque JSON object echoed back verbatim as subscription_metadata on every delivery envelope.
name String!
Display name of the subscription.
status WebhookSubscriptionStatus!
Current lifecycle status. ACTIVE delivers; DISABLED_BY_USER is a manual pause; DISABLED_BY_FAILURES is a system auto-disable triggered by a 410 Gone, 20 consecutive exhausted deliveries, or 3 days of continuous failure — re-enable via enableWebhookSubscription.
updatedAt DateTimeWithZone!
When the subscription was last updated.
url String!
HTTPS endpoint deliveries are POSTed to.
viewIds [ID!]!
Content-view (FilterPreset) UUIDs whose newly-matching items trigger deliveries (the View-filter-as-event-type model).