Converge JS

​

Installation Instructions

<script
  src="<https://static.runconverge.com/pixels/{YOUR_PUBLIC_TOKEN}.js>"
  async
></script>
<script>
  window.cvg||(c=window.cvg=function(){c.process?c.process.apply(c,arguments):c.queue.push(arguments)},c.queue=[]);
  cvg({method:"track",eventName:"$page_load"});
</script>

​

Note for Single-page applications

import { useEffect } from "react";
const MyApp = ({ Component, pageProps, router }) => {
  useEffect(() => {
    const handleRouteChange = (url) => {
      cvg({ method: "track", eventName: "$page_load" });
    };
    router.events.on("routeChangeComplete", handleRouteChange);
    return () => {
      router.events.off("routeChangeComplete", handleRouteChange);
    };
  }, []);
  return <Component {...pageProps} />;
};
export default MyApp;

​

Cross-domain tracking

Converge supports cross-domain tracking out-of-the-box. To enable cross-domain tracking from myfirstdomain.com to myotherdomain.com, include the following method together with the basic Converge pixel snippet.

cvg({ method: "link_domain", domain: "myotherdomain.com" });

​

Manually instrumenting events

If the pre-built website integrations do not cover the entire Converge Event Spec; or if you want to add custom events from your website then you will need to manually instrument these using the Converge Pixel. You can use the track method in the Converge Pixel for this purpose.

The track method has the following parameters:

• eventName: The name of the event
• properties: The event properties you want to pass, covering the Converge Spec and possibly your own custom properties.
• profileProperties: The profile properties
• aliases: Any aliases

cvg({
  method: "track",
  eventName: "Added To Cart",
  properties: {
    product_id: "123456",
    variant_id: "78910",
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla",
    price: 42,
    currency: "USD",
    quantity: 1,
    vendor: "My Store",
  },
});

​

Event Spec

This integration auto-tracks the following events with all properties available according to the Converge Event Spec.