Skip to content

FunnelKit

New in 3.16.0 (Pro). The funnelkit-read dispatcher inspects FunnelKit Funnel Builder through its own REST controllers. FunnelKit must be active, the tool must be enabled, and the connected user must have manage_woocommerce. FunnelKit’s endpoint permissions also apply.

Call funnelkit-read({}) to discover the operation catalog.

OperationArgumentsReturns
list-funnelslimit, offset, status, s, categoriesFunnels with compact, ordered step summaries
get-funnelfunnel_idOne funnel and its ordered steps
get-funnel-pagestep_id, detailPage summary, or decoded configuration with detail: "full"
get-checkout-productsstep_idProduct IDs, quantities, discounts, and effective checkout prices
get-checkout-fieldsstep_idCheckout fieldsets in saved order, including labels, types, required flags, and custom fields

list-funnels defaults to 20 results, with a maximum limit of 100. Use offset to paginate. Use actual IDs returned by discovery, not guessed IDs.

funnelkit-read({ operation: "list-funnels", arguments: {
limit: 10, offset: 0
} })

Select a returned funnel ID and pass it as funnel_id to get-funnel. Use a returned step ID as step_id for the page operation, or a checkout step ID for the checkout operations.

get-funnel-page defaults to detail: "summary". Request detail: "full" only when you need the decoded design, customization, settings, and checkout configuration.

This integration is read-only. There is no funnelkit-write tool in 3.16.0. It does not create or edit funnels, run FunnelKit Automations, manage contacts, or retrieve conversion statistics.

Checkout inspection describes the configuration saved in FunnelKit. General catalog and order operations belong to the separate WooCommerce integration.