Connect Shopify

Shopify sends paid and updated orders to webhooks signed with your store's webhook key. A cart attribute carries the visitor ID onto each order.

Set up the webhooks

1. Install the MetricRaven script in your theme

   Follow Install on Shopify.

2. Copy the webhook URL

   In MetricRaven, open Settings → Integrations → Shopify and copy the webhook URL.

3. Create two webhooks in Shopify

   In Shopify admin, open Settings → Notifications → Webhooks → Create webhook. Create one for Order payment and one for Order update, both in JSON format with the latest API version and this URL.

4. Paste the signing key in MetricRaven

   Below the webhook list Shopify shows the key your webhooks are signed with. Paste it into the Shopify card and choose Connect Shopify. For a custom app's webhooks, use the app's client secret instead.

Add the visitor ID to the cart

Cart attributes are copied to the order's note_attributes. Add this to your theme after the MetricRaven script; it sets the metricraven_visitor_id attribute:

<!-- Shopify admin → Online Store → Themes → Edit code → layout/theme.liquid, before </body>.
     The MetricRaven script tag must already be installed in the theme. -->
<script>
  (function () {
    function save() {
      var id = window.analytics && window.analytics.getVisitorId && window.analytics.getVisitorId();
      if (!id) return;
      // Cart attributes are copied to the order's note_attributes.
      fetch((window.Shopify && Shopify.routes ? Shopify.routes.root : "/") + "cart/update.js", {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ attributes: { metricraven_visitor_id: id } }),
      });
    }
    window.addEventListener("analytics:visitor", save);
    window.addEventListener("load", save);
  })();
</script>

Customers' emails are also matched to emails you sent to the Identify API.

MetricRaven links each payment to a visit using the first of these that is available:

1. The metricraven_visitor_id passed through checkout.
2. The metricraven_user_id (or the provider's customer external ID), matched to a visitor you linked with the Identify API.
3. An earlier payment from the same provider customer, so renewals keep the original attribution.
4. The checkout email, matched to an email you sent to the Identify API.
5. The checkout email, matched to a browser that called payment({ email }) within an hour of the payment.