# createTrackingFunction

Returns a function sending POST requests to a dedicated tracking endpoint fully compliant with the Workleap platform tracking API.

const track = createTrackingFunction(options?: { targetProductId })

• options: An optional object literal of options:
  • targetProductId: The product id of the target product. Useful to track an event for another product.

A TrackingFunction with the following signature: (eventName, properties: {}, options?: { keepAlive }) => Promise<void>.

• eventName: The event name.
• properties: The event properties.
• options: An optional object literal of options:
  • keepAlive: Whether or not to keep the connection alive for the tracking request. It is mostly used for tracking links where the user might navigate away before the request is completed.

If the initializeMixpanel function hasn't been executed yet and the Mixpanel context is not available, an Error is thrown.

import { createTrackingFunction } from "@workleap/mixpanel";

const track = createTrackingFunction();

track("ButtonClicked", { "Trigger": "ChangePlan", "Location": "Header" });

To track an action targeting another product, use the targetProductId option:

import { createTrackingFunction } from "@workleap/mixpanel";

const track = createTrackingFunction({
    targetProductId: "wov"
});

track("ButtonClicked", { "Trigger": "ChangePlan", "Location": "Header" });

To track a link click, use the keepAlive option to keep the page alive while the tracking request is being processed:

import { createTrackingFunction } from "@workleap/mixpanel";

const track = createTrackingFunction();

track("LinkClicked", { "Trigger": "ChangePlan", "Location": "Header" }, {
    keepAlive: true
});