createWebhookSubscription

Create an outbound-webhook subscription. Returns the signing secret exactly once.

MCP: createWebhookSubscription

Arguments

input CreateWebhookSubscriptionInput! required: Mutation input.

Returns

secret String: The plaintext signing secret (whsec_-prefixed). Returned ONLY here and from rotateWebhookSubscriptionSecret — store it now; it is never shown again. The whsec_ prefix is PART OF THE HMAC key; do not strip it when verifying X-Archive-Signature.
userErrors [UserError!]!: List of user-facing validation errors. Empty on success.
webhookSubscription WebhookSubscription: The newly created subscription. Null on failure.

Open in explorer ↗

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

Subscribe an HTTPS endpoint to new items landing in a content view. `secret` is the signing secret and is returned exactly once — store it now, no read ever re-exposes it.

query.graphql

mutation CreateWebhookSubscriptionDefault($input: CreateWebhookSubscriptionInput!) {
  createWebhookSubscription(input: $input) {
    webhookSubscription {
      id
      name
      url
      eventTypes
      viewIds
      metadata
      status
    }
    secret
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "input": {
    "name": "Fulfilment webhook",
    "url": "https://hooks.northwind-botanicals.example/archive/new-content",
    "viewIds": [
      "eaa824b8-374f-5db8-bee2-51dfd8c3776c"
    ],
    "eventTypes": [
      "content_view.item_added"
    ],
    "metadata": {
      "team": "fulfilment"
    }
  }
}

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 CreateWebhookSubscriptionDefault($input: CreateWebhookSubscriptionInput!) {\n  createWebhookSubscription(input: $input) {\n    webhookSubscription {\n      id\n      name\n      url\n      eventTypes\n      viewIds\n      metadata\n      status\n    }\n    secret\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "input": {
      "name": "Fulfilment webhook",
      "url": "https://hooks.northwind-botanicals.example/archive/new-content",
      "viewIds": [
        "eaa824b8-374f-5db8-bee2-51dfd8c3776c"
      ],
      "eventTypes": [
        "content_view.item_added"
      ],
      "metadata": {
        "team": "fulfilment"
      }
    }
  }
}'

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 CreateWebhookSubscriptionDefault($input: CreateWebhookSubscriptionInput!) {
  createWebhookSubscription(input: $input) {
    webhookSubscription {
      id
      name
      url
      eventTypes
      viewIds
      metadata
      status
    }
    secret
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "input": {
        "name": "Fulfilment webhook",
        "url": "https://hooks.northwind-botanicals.example/archive/new-content",
        "viewIds": [
          "eaa824b8-374f-5db8-bee2-51dfd8c3776c"
        ],
        "eventTypes": [
          "content_view.item_added"
        ],
        "metadata": {
          "team": "fulfilment"
        }
      }
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation CreateWebhookSubscriptionDefault($input: CreateWebhookSubscriptionInput!) {
    createWebhookSubscription(input: $input) {
      webhookSubscription {
        id
        name
        url
        eventTypes
        viewIds
        metadata
        status
      }
      secret
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "input" => { "name" => "Fulfilment webhook", "url" => "https://hooks.northwind-botanicals.example/archive/new-content", "viewIds" => ["eaa824b8-374f-5db8-bee2-51dfd8c3776c"], "eventTypes" => ["content_view.item_added"], "metadata" => { "team" => "fulfilment" } } } }.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 CreateWebhookSubscriptionDefault($input: CreateWebhookSubscriptionInput!) {
  createWebhookSubscription(input: $input) {
    webhookSubscription {
      id
      name
      url
      eventTypes
      viewIds
      metadata
      status
    }
    secret
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"input": {"name": "Fulfilment webhook", "url": "https://hooks.northwind-botanicals.example/archive/new-content", "viewIds": ["eaa824b8-374f-5db8-bee2-51dfd8c3776c"], "eventTypes": ["content_view.item_added"], "metadata": {"team": "fulfilment"}}}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "data": {
    "createWebhookSubscription": {
      "webhookSubscription": {
        "id": "b24c9093-72a3-504d-b97c-cb023efca979",
        "name": "Fulfilment webhook",
        "url": "https://hooks.northwind-botanicals.example/archive/new-content",
        "eventTypes": [
          "content_view.item_added"
        ],
        "viewIds": [
          "eaa824b8-374f-5db8-bee2-51dfd8c3776c"
        ],
        "metadata": {
          "team": "fulfilment"
        },
        "status": "ACTIVE"
      },
      "secret": "whsec_EXAMPLE_SECRET_SHOWN_ONCE_DO_NOT_USE",
      "userErrors": []
    }
  }
}