Skip to content

ConvertKit for WooCommerce API Calls

George Gecewicz edited this page Jan 20, 2021 · 3 revisions

All API calls in ConvertKit for WooCommerce—in both the admin and on the front-end—are via the ckwc_convertkit_api_request() plugin function.

Admin User Actions

Accessing WooCommerce > Integrations > ConvertKit Settings Page when ckwc_subscription_options Is Expired or Not Set

  • https://api.convertkit.com/v3/courses?api_key=[api key]
  • https://api.convertkit.com/v3/forms?api_key=[api key]
  • https://api.convertkit.com/v3/tags?api_key=[api key]

Clicking "Refresh subscription options" in WooCommerce > Integrations > ConvertKit Settings Page

  • https://api.convertkit.com/v3/courses?api_key=[api key]
  • https://api.convertkit.com/v3/forms?api_key=[api key]
  • https://api.convertkit.com/v3/tags?api_key=[api key]

Clicking "Save Changes" in WooCommerce > Integrations > ConvertKit Settings Page

  • https://api.convertkit.com/v3/forms?api_key=[api key]

Manually Creating a "Subscribe Event"

For example, if the "Subscribe Event" option in the WooCommerce > Integrations > ConvertKit settings page is set to "Order Completed", and as an admin you manually set a WooCommerce order's status from "Processing" to "Completed":

  • https://api.convertkit.com/v3/forms/[ck form id]/subscribe?api_key=[api key]

And if you have the "Send purchase data to ConvertKit" and "Send purchase data from manual orders to ConvertKit" options checked:

  • https://api.convertkit.com/v3/purchases?api_key=[api key]

Front-End User Actions

Completing a Purchase

For example, if the "Subscribe Event" option in the WooCommerce > Integrations > ConvertKit settings page is set to "Order Created", and as a front-end user you add an item to your cart and complete the checkout process, then click "Place order" and the order does not fail for any reason:

Note that if the "Send purchase data to ConvertKit" and "Send purchase data from manual orders to ConvertKit" options are checked, the data will not be sent to ConvertKit until the Order status is "Completed", regardless of what the "Subscribe Event" option is set to. When it finally does get set to "Completed", the API call will be this:

  • https://api.convertkit.com/v3/purchases?api_key=[api key]
Clone this wiki locally