To verify or troubleshoot your integration, follow these steps to ensure everything is working properly.
Overview:
Download the ShopMessage Integration Helper Chrome Extension
Verify the ShopMessage SDK loads on your website
Activate Preserve Events within the Integration Helper
Verify that the Checkbox Widget renders on product pages, firing events:
FBCheckboxRendered,
ViewProduct
,FBCheckboxChecked
Verify that clicking the Add to Cart button, fires the following events:
MessengerOptin
,UpdateCart
Verify that Completing a Purchase fires the following event:
PurchaseComplete
After you've downloaded the Integration Helper, follow these steps:
Step 1: Download the ShopMessage Integration Helper Chrome Extension
Step 2: Verify that the ShopMessage SDK loads on your website.
The ShopMessage Integration Helper works in the background to check your website for the ShopMessage SDK. When a website has the ShopMessage SDK installed, the icon in your browser turns blue and a badge will appear indicating the number of events found on the page. Click the icon for more details.
Please note, the icon will remain gray if there is no ShopMessage SDK detected on your page.
When you have properly installed ShopMessage on your website you should see the ShopMessage SDK appear on every page of your site. Here's an example of what the ShopMessage Integration Helper should look like when the SDK is detected, but no events are firing.
Step 3: Activate Preserve Events within the Integration Helper
Preserving your events allows you to see every ShopMessage event that has fired on each page that you visited, within your current browsing session.
To do this, open your ShopMessage Integration helper and click on Options. From there, click the Preserve Events button. When Preserve Events is turned on the button will appear blue.
Step 4: Verify that the Checkbox Widget renders on product pages, firing events:
FBCheckboxRendered
, ViewProduct
and FBCheckboxChecked
Navigate to your product page and click on the ShopMessage Integration Helper Icon chrome extension. By default you will navigate to the Events tab.
A properly set up product page will fire three events, ViewProduct
, FBCheckboxRendered
, and FBCheckboxChecked
. You can expand each event for details.
Please note:
If you do not have pre-check approval from Facebook you will need to manually check the checkbox widget for the third event to fire.
Events may take 5-10 seconds to load.
Step 4: Verify that clicking the Add to Cart button, fires the following events:
MessengerOptin
and UpdateCart
Ensure that your checkbox widget is checked (either manually or automatically) and click the your Add to Cart button.
After you've clicked add to cart, you will be redirected to the shopping cart of your page. Since we've preserved the events of the previous page, you will now see five events firing. The two new events are MessengerOptin
and UpdateCart.
Step 5: Verify that Completing a Purchase fires the following event:
PurchaseComplete
Complete a test purchase to ensure your PurchaseComplete
event is firing. Then expand the event details to confirm that the that the order_id
and total_price
fields are filled out.
This is important so we don't sent users abandoned cart reminders after they've made a purchase.
Once you've confirmed all of your events are firing your ShopMessage integration is complete! If you have any questions, or feedback about our Integration Helper, please reach out at [email protected].