Jump to examples ↓

Query

webhookSubscriptions

List outbound-webhook subscriptions for the current workspace, newest first. Returns at most 1000 rows; this field is not paginated.

Arguments

This field takes no arguments.

Returns

Returns [WebhookSubscription!]! .

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.

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.

Open in explorer ↗

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

Return the workspace's outbound-webhook subscriptions as a capped, newest-first list that can be truncated; use webhookSubscriptionsConnection to enumerate every page.

query.graphql

query WebhookSubscriptionsDefault {
  webhookSubscriptions {
    id
    name
    url
    eventTypes
    viewIds
    metadata
    status
    consecutiveFailures
    disabledAt
  }
}

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": "query WebhookSubscriptionsDefault {\n  webhookSubscriptions {\n    id\n    name\n    url\n    eventTypes\n    viewIds\n    metadata\n    status\n    consecutiveFailures\n    disabledAt\n  }\n}"
}'

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: `query WebhookSubscriptionsDefault {
  webhookSubscriptions {
    id
    name
    url
    eventTypes
    viewIds
    metadata
    status
    consecutiveFailures
    disabledAt
  }
}`
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query WebhookSubscriptionsDefault {
    webhookSubscriptions {
      id
      name
      url
      eventTypes
      viewIds
      metadata
      status
      consecutiveFailures
      disabledAt
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query }.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 = """
query WebhookSubscriptionsDefault {
  webhookSubscriptions {
    id
    name
    url
    eventTypes
    viewIds
    metadata
    status
    consecutiveFailures
    disabledAt
  }
}
"""

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

200 OK 40 lines

{
  "data": {
    "webhookSubscriptions": [
      {
        "id": "41662e09-10c4-52e4-844a-62ddedb38f11",
        "name": "Northwind Analytics Sink",
        "url": "https://analytics.northwind-botanicals.example/archive",
        "eventTypes": [
          "content_view.item_added"
        ],
        "viewIds": [
          "eaa824b8-374f-5db8-bee2-51dfd8c3776c"
        ],
        "metadata": {
          "team": "growth"
        },
        "status": "DISABLED_BY_FAILURES",
        "consecutiveFailures": 20,
        "disabledAt": "2024-12-31T13:00:00Z"
      },
      {
        "id": "eb418e28-bf9d-5350-b87b-446a6813bca4",
        "name": "Northwind Order Fulfilment",
        "url": "https://hooks.northwind-botanicals.example/archive",
        "eventTypes": [
          "content_view.item_added"
        ],
        "viewIds": [
          "eaa824b8-374f-5db8-bee2-51dfd8c3776c"
        ],
        "metadata": {
          "team": "growth"
        },
        "status": "ACTIVE",
        "consecutiveFailures": 0,
        "disabledAt": null
      }
    ]
  }
}