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

secret String: The new plaintext signing secret (whsec_-prefixed). Returned ONLY here and from createWebhookSubscription — store it now; it is never shown again. 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 accepting either verifies 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.
webhookSubscription WebhookSubscription: The subscription after rotation. Null when not found.

Open in explorer ↗

Values are sampled from a demo workspace — substitute your own token and workspace id.

Mint a new signing secret, returned exactly once. The previous secret keeps verifying for a 24h overlap so you can roll the new one out without dropping deliveries.

query.graphql

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

variables.json

{
  "id": "eb418e28-bf9d-5350-b87b-446a6813bca4"
}

Headers

Authorization: Bearer docs_demo_token_0000000000000000000000
WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -H 'WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a' \
  -d '{
  "query": "mutation RotateWebhookSubscriptionSecretDefault($id: ID!) {\n  rotateWebhookSubscriptionSecret(id: $id) {\n    webhookSubscription {\n      id\n      name\n      status\n    }\n    secret\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "id": "eb418e28-bf9d-5350-b87b-446a6813bca4"
  }
}'

Request · Node.js

const response = await fetch("https://app.archive.com/api/v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer docs_demo_token_0000000000000000000000",
    "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
  },
  body: JSON.stringify({
    query: `mutation RotateWebhookSubscriptionSecretDefault($id: ID!) {
  rotateWebhookSubscriptionSecret(id: $id) {
    webhookSubscription {
      id
      name
      status
    }
    secret
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "id": "eb418e28-bf9d-5350-b87b-446a6813bca4"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation RotateWebhookSubscriptionSecretDefault($id: ID!) {
    rotateWebhookSubscriptionSecret(id: $id) {
      webhookSubscription {
        id
        name
        status
      }
      secret
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "id" => "eb418e28-bf9d-5350-b87b-446a6813bca4" } }.to_json,
  "Content-Type" => "application/json",
  "Authorization" => "Bearer docs_demo_token_0000000000000000000000",
  "WORKSPACE-ID" => "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
)
puts response.body

Request · Python

import json
import requests

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

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"id": "eb418e28-bf9d-5350-b87b-446a6813bca4"}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "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": []
    }
  }
}