Send events from your site

Once the tracker is installed, page views are sent on their own. Everything else, a form submission, a booking, a purchase, is one call to PixelRelayTracker.track() at the moment it happens.

The basic call#

PixelRelayTracker.track('schedule_appointment');

The name is yours to choose. Use lowercase words with underscores, and give each kind of conversion its own name. Then map the name to the Meta event it should count as, here Lead.

Adding a value#

The second argument is the event's details. Only these fields are sent on, anything else is dropped:

PixelRelayTracker.track('purchase', { value: 99.5, currency: 'GBP', content_ids: ['consult-30'] });

Adding customer details#

The third argument is who the visitor is, when you know it, for example from a form they just sent. Meta uses it to match the event to a person. The relay hashes every one of these with SHA-256 before sending, and never stores them:

form.addEventListener('submit', () => {
    PixelRelayTracker.track('schedule_appointment', { value: 150, currency: 'GBP' }, {
        email: form.email.value,
        phone: form.phone.value,
        first_name: form.first_name.value,
    });
});

Pass null or {} as the second argument when there are no details: track('lead', {}, { email }).

Shortcuts#

The tracker has helpers for Meta's common events. They send the standard names, already in the default mappings:

PixelRelayTracker.trackLead({ email: 'person@example.com' });           // lead
PixelRelayTracker.trackPurchase(99.5, 'GBP', ['consult-30']);           // purchase
PixelRelayTracker.trackAddToCart(['consult-30'], 99.5, 'GBP');          // add_to_cart
PixelRelayTracker.trackViewContent('consult-30', 'Consultation', 99.5, 'GBP'); // view_content
PixelRelayTracker.trackInitiateCheckout(99.5, 'GBP', ['consult-30']);   // initiate_checkout

All the options and methods are in the tracker reference.