Mutation

rotateWebhookSubscriptionSecret

Rotate a webhook subscription signing secret. Returns the new secret once.

MCP: rotateWebhookSubscriptionSecret

Arguments

id ID! required: UUID of the subscription to rotate.

Returns

Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

secret String: The new plaintext signing secret (whsec_-prefixed). Returned only here and from createWebhookSubscription, and never shown again, so store it immediately. During the 24h dual-sign overlap, deliveries are signed with both the new and previous secrets (two v1= values in X-Archive-Signature), so a receiver that accepts either signature cuts over without dropping a delivery. The whsec_ prefix is part of the HMAC key; do not strip it.
userErrors [UserError!]!: List of user-facing errors. Populated only when rotation failed.
field [String!]: Path to the input field that caused the error.
message String!: The error message.
webhookSubscription WebhookSubscription: The subscription after rotation. Null when not found.
consecutiveFailures Int!: Consecutive failed deliveries since the last success. 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 with enableWebhookSubscription.
ACTIVE: The subscription is active and receives matching events.
DISABLED_BY_FAILURES: The subscription was disabled by the system after sustained delivery failures (a 410 Gone, 20 consecutive exhausted deliveries, or 3 days of continuous failure). Re-enable it with the enableWebhookSubscription mutation.
DISABLED_BY_USER: The subscription was paused by the workspace and delivers nothing until re-enabled.
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.

mutation RotateWebhookSubscriptionSecretDefault($id: ID!) { rotateWebhookSubscriptionSecret(id: $id) { webhookSubscription { id name status } secret userErrors { field message } } }

{ "data": { "rotateWebhookSubscriptionSecret": { "webhookSubscription": { "id": "eb418e28-bf9d-5350-b87b-446a6813bca4", "name": "Northwind Order Fulfilment", "status": "ACTIVE" }, "secret": "whsec_EXAMPLE_SECRET_SHOWN_ONCE_DO_NOT_USE", "userErrors": [] } } }