sendWebhookTestEvent

Send a signed synthetic ping to a subscription's endpoint and return the settled delivery.

MCP: sendWebhookTestEvent

Arguments

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

Returns

userErrors [UserError!]!: List of user-facing errors. Populated when the subscription was not found or the ping was rate-limited — both surface on ["id"].
webhookDelivery WebhookDelivery: The settled test delivery (status / lastResponseStatus / responseTimeMs). Null when the subscription is not found or the ping is rate-limited. The ping shares the outer envelope + signature with real events, so it validates transport + X-Archive-Signature verification end-to-end. Its data is { ping: true, subscription_id, sent_at } — NOT the content_view.item_added { item, view } shape — so do not point an item/view parser at a ping.

Open in explorer ↗

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

POST a signed synthetic ping to the subscription's endpoint and return the settled delivery, so you can verify transport and signature verification end to end. The ping payload is { ping, subscription_id, sent_at } — not the content_view.item_added shape.

query.graphql

mutation SendWebhookTestEventDefault($id: ID!) {
  sendWebhookTestEvent(id: $id) {
    webhookDelivery {
      id
      subscriptionId
      eventId
      status
      attemptCount
      lastResponseStatus
      responseTimeMs
    }
    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 SendWebhookTestEventDefault($id: ID!) {\n  sendWebhookTestEvent(id: $id) {\n    webhookDelivery {\n      id\n      subscriptionId\n      eventId\n      status\n      attemptCount\n      lastResponseStatus\n      responseTimeMs\n    }\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 SendWebhookTestEventDefault($id: ID!) {
  sendWebhookTestEvent(id: $id) {
    webhookDelivery {
      id
      subscriptionId
      eventId
      status
      attemptCount
      lastResponseStatus
      responseTimeMs
    }
    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 SendWebhookTestEventDefault($id: ID!) {
    sendWebhookTestEvent(id: $id) {
      webhookDelivery {
        id
        subscriptionId
        eventId
        status
        attemptCount
        lastResponseStatus
        responseTimeMs
      }
      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 SendWebhookTestEventDefault($id: ID!) {
  sendWebhookTestEvent(id: $id) {
    webhookDelivery {
      id
      subscriptionId
      eventId
      status
      attemptCount
      lastResponseStatus
      responseTimeMs
    }
    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": {
    "sendWebhookTestEvent": {
      "webhookDelivery": {
        "id": "51e830cd-4071-5889-9304-2ac229f5cf70",
        "subscriptionId": "eb418e28-bf9d-5350-b87b-446a6813bca4",
        "eventId": "4849ae8e-b058-59bb-95b3-4e993b82807c",
        "status": "SUCCEEDED",
        "attemptCount": 1,
        "lastResponseStatus": 200,
        "responseTimeMs": 142
      },
      "userErrors": []
    }
  }
}