Shopify
Get Shopify data in Converge.
1. Access Requirements
a) Step-by-step
- Give the Converge Team access your store URL (e.g.
converge-test.myshopify.com
). -
Once the Converge Team has sent you a request for collaboration, you will receive a
New collaborator request
notification fromcontact@runconverge.com
. -
Go to the Users and Permissions settings by clicking
Settings
, then click onUsers and permissions
. -
Scroll down to Collaborators and click on
Converge
. -
Scroll down to Permissions and add
View customer events
andManage and add custom pixels
. -
Click on
Accept Request
. - Done 🎉
2. Installing Converge on Shopify
🧑💻🔧 This section is for developers.
a) Tracking Shopify Server Events
Event Spec
This integration auto-tracks the following events on the server with all properties available according to the Converge Event Spec.
Placed Order
Step-by-step
- In Converge, navigate to the Sources tab and click on Create a new source
- Name your datasource: e.g.
{store_name} Store
- Enter the store name, this is the string before
myshopify.com
in the shopify url. E.g. Forconvergestore.myshopify.com
the store name would beconvergestore
- Navigate to the Shopify dashboard, click on Settings
- Click on Apps and and sales channels in the Settings modal
- Click on Develop apps, you might have to choose allow custom app development in a pop-up
- Click on Create an app, give the app the name
Converge
and choose your own email address as the developer - Choose Configure Admin API scopes and mark the following 4 scopes (i)
read_products
, (ii)read_customer_events
, (iii)read_customers
, (iv)read_orders
. - Click on Save and then Install app. Reveal and copy the Admin API access token, paste the token in the Converge webapp under Shopify API Password. Do not fill in a starting date, just click on Create source
ℹ️ You should see the Shopify store syncing data, no need to wait before its fully synced to create connections – we will automatically check which orders are historic and new and forward only the new ones in case a connection is active while historically syncing
Video Tutorial
The following video walks you through the steps above.
b) Tracking Shopify Checkout Events
Event Spec
This integration auto-tracks the following events on the Shopify Checkout with all properties available according to the Converge Event Spec.
Started Checkout
Added Contact Info
Added Payment Info
Step-by-step
- In Converge, click on Create a new source
- Pick Client-side from the modal
- Name your pixel: e.g.
{Storename} Checkout
- After creating the pixel, click on your pixel and from the modal pick Shopify Custom Pixel, copy the snippet
- In the Shopify dashboard, navigate to Settings > Customer Events
- Click on Add custom pixel
- Name your pixel, e.g.
Converge Pixel
- Paste the script from the webapp here, make sure to modify the
__SHOP_NAME__
string with the actual store name e.g.convergestore
. - Click on Save Pixel and Connect Pixel
- Go through checkout, and check in the Sources and Profiles tab that the pixel actually receives events . You might have to refresh the dashboard to see new events coming in.
c) Tracking Shopify Storefront Events
Event Spec
This integration auto-tracks the following events on the Shopify Checkout with all properties available according to the Converge Event Spec.
$page_load
Viewed Product
Viewed Collection
Added To Cart
Step-by-step | Standard Shopify Theme
ℹ️ This is for a non-headless Shopify setup. For a headless Shopify setup, please check below.
- In Converge, click on Create a new source
- Pick Client-side from the modal
- Name your pixel: e.g.
{Storename} Storefront
- Copy the Shopify Liquid snippet
- In the Shopify dashboard, navigate to Sales Channels > Online Store > Themes
- Click on “…” next to the Customize button, and click Edit code.
- Go to the theme.liquid file and insert the snippet right above the closing </head> tag in the theme.liquid file. Click Save
- Always doublecheck that you did not break anything on the site after inserting the snippet It’s good practice to add the snippet to other themes in development as well, so a theme switch does not kill website tracking
- Check that your pixel is working correctly by generating some page_load events through visiting the store and seeing that these events arrive in Converge.
Step-by-step | Headless Shopify Setup
ℹ️ This is for a headless Shopify setup. For a non-headless Shopify setup, please check above.
- In Converge, click on Create a new source
- Pick Client-side from the modal
- Name your pixel: e.g.
{Storename} Storefront
- Copy the Shopify Liquid snippet
- In the Shopify dashboard, navigate to Sales Channels > Online Store > Themes
- Click on “…” next to the Customize button, and click Edit code.
- Go to the theme.liquid file and insert the snippet right above the closing </head> tag in the theme.liquid file. Click Save
- Always doublecheck that you did not break anything on the site after inserting the snippet It’s good practice to add the snippet to other themes in development as well, so a theme switch does not kill website tracking
- Check that your pixel is working correctly by generating some page_load events through visiting the store and seeing that these events arrive in Converge.