Archive API docs
esc
    Jump to
    Getting started Token, first query, response Explorer Run queries in the browser items The connection most integrations start with Changelog Additions and deprecations

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    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]. operation.completed (not view-scoped) fires once when a refetch_engagement or oneschema_creator_import operation finishes.
    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. Must not be blank; at most 200 characters.
    url String! required
    HTTPS endpoint deliveries are POSTed to. Validated against SSRF ranges; at most 2048 characters.
    viewIds [ID!] default []
    Content View (FilterPreset) UUIDs whose newly matching items trigger deliveries. Required when any subscribed event type is view-scoped (content_view.item_added): pass at least one UUID, each owned by the workspace. Must be omitted or empty when only operation.completed is subscribed. Express each content condition you want to be notified about (verified mentions, usage-rights approved, high EMV, and so on) as a Content View whose filters encode that condition, then point viewIds at it.