updateWebhookSubscription

Partial-update a webhook subscription.

MCP: updateWebhookSubscription

Arguments

id ID! required: UUID of the subscription to update.
input UpdateWebhookSubscriptionInput! required: Partial-update input. Only provided fields are updated.

Returns

userErrors [UserError!]!: List of user-facing validation errors. Empty on success.
webhookSubscription WebhookSubscription: The updated subscription. Null on failure or when not found.

Open in explorer ↗

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

Partial-update a subscription — only the fields you send change. Setting status to DISABLED_BY_USER is how you pause deliveries without deleting the subscription.

query.graphql

mutation UpdateWebhookSubscriptionDefault($id: ID!, $input: UpdateWebhookSubscriptionInput!) {
  updateWebhookSubscription(id: $id, input: $input) {
    webhookSubscription {
      id
      name
      url
      status
      metadata
    }
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "id": "eb418e28-bf9d-5350-b87b-446a6813bca4",
  "input": {
    "name": "Northwind Order Fulfilment (paused)",
    "status": "DISABLED_BY_USER"
  }
}

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 UpdateWebhookSubscriptionDefault($id: ID!, $input: UpdateWebhookSubscriptionInput!) {\n  updateWebhookSubscription(id: $id, input: $input) {\n    webhookSubscription {\n      id\n      name\n      url\n      status\n      metadata\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "id": "eb418e28-bf9d-5350-b87b-446a6813bca4",
    "input": {
      "name": "Northwind Order Fulfilment (paused)",
      "status": "DISABLED_BY_USER"
    }
  }
}'

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 UpdateWebhookSubscriptionDefault($id: ID!, $input: UpdateWebhookSubscriptionInput!) {
  updateWebhookSubscription(id: $id, input: $input) {
    webhookSubscription {
      id
      name
      url
      status
      metadata
    }
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "id": "eb418e28-bf9d-5350-b87b-446a6813bca4",
      "input": {
        "name": "Northwind Order Fulfilment (paused)",
        "status": "DISABLED_BY_USER"
      }
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation UpdateWebhookSubscriptionDefault($id: ID!, $input: UpdateWebhookSubscriptionInput!) {
    updateWebhookSubscription(id: $id, input: $input) {
      webhookSubscription {
        id
        name
        url
        status
        metadata
      }
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "id" => "eb418e28-bf9d-5350-b87b-446a6813bca4", "input" => { "name" => "Northwind Order Fulfilment (paused)", "status" => "DISABLED_BY_USER" } } }.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 UpdateWebhookSubscriptionDefault($id: ID!, $input: UpdateWebhookSubscriptionInput!) {
  updateWebhookSubscription(id: $id, input: $input) {
    webhookSubscription {
      id
      name
      url
      status
      metadata
    }
    userErrors {
      field
      message
    }
  }
}
"""

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

200 OK

{
  "data": {
    "updateWebhookSubscription": {
      "webhookSubscription": {
        "id": "eb418e28-bf9d-5350-b87b-446a6813bca4",
        "name": "Northwind Order Fulfilment (paused)",
        "url": "https://hooks.northwind-botanicals.example/archive",
        "status": "DISABLED_BY_USER",
        "metadata": {
          "team": "growth"
        }
      },
      "userErrors": []
    }
  }
}