Archive API docs

Input object

CreateWebhookSubscriptionInput

Input for the createWebhookSubscription mutation.

Fields

eventTypes [String!] default: ["content_view.item_added"]
Event types to subscribe to. Defaults to [content_view.item_added], the only subscribable type in v1.
metadata JSON default: {}
Opaque JSON object echoed back verbatim as subscription_metadata on every delivery envelope — use it to carry your own reference IDs. Capped at 4 KB serialized. Pass an object, not a stringified blob.
name String! required
Display name for the subscription.
url String! required
HTTPS endpoint deliveries are POSTed to. Validated against SSRF ranges.
viewIds [ID!] default: []
Content-view (FilterPreset) UUIDs whose newly-matching items trigger deliveries. REQUIRED (at least one, each owned by the workspace) when any subscribed event type is view-scoped — which is every subscribable type in v1 — and must be omitted for non-view event types (none subscribable yet). This is the View-filter-as-event-type model: v1 ships one event type (content_view.item_added), so you express every "event type" you want (verified mentions, usage-rights approved, high-EMV, etc.) as a Content View whose filters encode that condition, then point viewIds at it. See the domain README "Outbound Webhooks" section for copy-paste recipes.