Archive API docs
    Jump to

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

    Input object

    UpdateWebhookSubscriptionInput

    Partial-update input for updateWebhookSubscription. Only provided fields are updated; omitted fields are left unchanged. An explicit null is refused with a userError on that field, except for metadata, where null clears it.

    Fields

    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.

    eventTypes [String!]
    Event types. When provided, replaces the existing list.
    metadata JSON
    Opaque metadata. When provided, replaces it (max 4KB serialized). Null or {} clears it.
    name String
    Display name. When provided, replaces the existing name. Must not be blank; at most 200 characters.
    status WebhookSubscriptionStatus
    Pause (DISABLED_BY_USER) or resume (ACTIVE) the subscription. DISABLED_BY_FAILURES is system-owned and rejected.
    url String
    HTTPS endpoint. When provided, re-validated against SSRF ranges; at most 2048 characters.
    viewIds [ID!]
    Content-view UUIDs. When provided, replaces the list (re-checked for ownership and the tier cap). Required while any subscribed event type is view-scoped (content_view.item_added); must be empty when only operation.completed is subscribed (send [], not null). Changing eventTypes re-checks this against the resulting combination.