​
Installation Instructions

1

Navigate to your WooCommerce REST API Settings

  1. Navigate to your WordPress Admin Dashboard.
  2. From the Menu Sidebar, navigate to the WooCommerce > Settings submenu.
  3. On the WooCommerce Settings Page, click on the Advanced tab in the top bar.
  4. In the Advanced Tab, click on the REST API link on the top of the page.
2

Generate your WooCommerce Consumer Key and Consumer Secret

  1. On the REST API page, click on the Add key button, this will open a menu to create a new key.
  2. Choose Converge for the Description-form field, your own account as the User, and choose Read as the Permissions.
  3. Click on Generate API Key.
  4. Copy the Consumer key and Consumer secret, you will need them to set up the Converge Source.
3

Create a new Server-side source in Converge

  1. In Converge, click on Create a new source
  2. Pick Server-side from the modal
  3. Name your source: e.g. {Storename} Store Backend
  4. Choose the WooCommerce app from the dropdown menu.
4

Connect the Source to WooCommerce

  1. Enter your Store URL in the URL of your WooCommerce store-field, including https://, e.g. https://myshop.com
  2. Paste the Consumer key and Consumer secret from your previous step.
  3. Click on Create Source.
You should see the Source syncing all historical order data, you should wait until it’s fully synced to create destinations

​
Event Spec

This integration auto-tracks the following events on the server with all properties available according to the Converge Event Spec.
Event NameEvent Description
Placed OrderWhen a customer places an order.

​
Sales Channels

Events received by Converge from a Woocommerce integration are automatically mapped to Converge’s sales channels types whenever possible. More on sales channels can be found here.
Converge fall back to “web” if a mapping cannot be found. This is typically the case with third party integrations with Woocommerce.
An example of how Converge map Woocommerce sales channels:
WoocommerceConvergeDescription
checkoutwebBrowser
subscriptionsubscription_contractSubscription events
adminofflineManual orders
rest-api-Depends on third party integration, defaults to “web” if no valid mapping is found

​
Third party integrations

For third-party integrations, Converge provides support for a metadata field that can be used to specify the sales channel type directly. This is particularly useful for custom implementations or when working with external systems that use the WooCommerce API to create or update orders. Converge reads the metadata field called sales_channel_type to determine the appropriate sales channel type for the event. This metadata can be set in WooCommerce orders to override the default channel mapping. If this field is present and has a valid sales channel type value, Converge uses it to categorize the sales channel.