ApexDocsOpen Apex
Merchants & developers

Install Apex on WooCommerce

Connect the Apex WooCommerce plugin with an install token, upload the plugin zip, and understand what WooCommerce data Apex receives.

The Apex WooCommerce plugin connects a WordPress/WooCommerce store to Apex with a short-lived install token. In Apex, the WooCommerce install action creates a token that starts with apx_woo_ and expires after 48 hours. In WordPress, you upload the plugin zip, paste the token in WooCommerce settings, and save.

After the token is claimed, the plugin stores the returned Apex shop ID, snippet URL, webhook URL, and webhook secret. It then injects the Apex storefront snippet and provisions WooCommerce order webhooks.

Before you start

  • Use WordPress 6 or newer, WooCommerce 7 or newer, and PHP 7.4 or newer.
  • Have WordPress admin access with permission to install plugins and manage WooCommerce settings.
  • Generate the token from Apex for the same shop you are connecting.
  • Use the latest apex-woocommerce.zip plugin package from Apex or your implementation handoff.

Generate the install token

  1. In Apex, open Settings, then Installation, then WooCommerce.
  2. Generate a WooCommerce install token.
  3. Copy the token. It is only useful for this connection flow and expires after 48 hours.

If the token expires, generate a new one in Apex and paste the new value into WordPress.

Upload the plugin zip

  1. In WordPress Admin, open Plugins, then Add New.
  2. Choose Upload Plugin.
  3. Upload apex-woocommerce.zip.
  4. Install and activate the plugin.

The plugin adds an Apex settings page under WooCommerce settings.

Connect in WooCommerce settings

  1. In WordPress Admin, open WooCommerce, then Settings, then Apex.
  2. Paste the apx_woo_... install token into Install token.
  3. Save changes.
  4. Confirm the page shows Connected with an Apex shop ID.

When the save succeeds, the plugin claims the token with Apex, stores the returned connection details, and creates native WooCommerce webhooks for order created and order updated events.

Confirm storefront tracking

The connected plugin injects the Apex snippet early in wp_head and loads a small WooCommerce bridge script. Visit the storefront in a normal browser session and then check Apex Installation or analytics to confirm events are arriving.

The bridge sends page context into window.dataLayer for virtual pageviews, add-to-cart clicks, checkout starts, and purchases. On checkout, the plugin stamps the Apex visitor ID, session ID, and experiment assignments onto the WooCommerce order when the Apex identity cookie is present.

What Apex receives

The WooCommerce plugin can send:

  • Storefront tracking events through the Apex snippet.
  • Page, product, cart, and order context from the WooCommerce bridge.
  • Native WooCommerce order created and order updated webhooks.
  • Signed refund events when a WooCommerce order is refunded.
  • A recent-order sync from the settings page, limited to recent orders and an allowlist of Apex attribution and cost metadata.

Webhook requests are signed with the plugin webhook secret. Apex rejects inactive installations, unknown store URLs, invalid signatures, missing topics, and missing delivery IDs.

Troubleshooting

  • If WordPress shows a registration error, generate a fresh token in Apex and confirm the token was copied completely.
  • If the settings page does not show Connected, confirm WooCommerce is active and the WordPress server can reach Apex over HTTPS.
  • If storefront events do not arrive, confirm the plugin is active and the connected settings page shows a snippet URL.
  • If order events are missing, open WooCommerce settings, Apex, and confirm native webhook IDs are present.
  • If historical orders are missing, use Sync recent orders from the Apex settings page after the connection is healthy.