API Reference

import {
  initialiseZeoCollect,
  setEventProperties,
  setEventNameProperties,
  setUserIdentities,
  setConsent
} from 'zeo-collect';

initialiseZeoCollect(options, callback?);

import { setEventNameProperties } from 'zeo-collect';

setEventNameProperties("primary_button_clicked");

// with callback
setEventNameProperties("primary_button_clicked", (res) => {
  // handle res.status / res.message
});

import { setEventProperties } from 'zeo-collect';

const eventProperties = { name, description, price };
setEventProperties("primary_button_clicked", eventProperties);

// with callback
setEventProperties("addToCart", eventProperties, (res) => {
  // handle response
});

setInstantEventNameProperties("checkout_complete");

setInstantEventProperties("checkout_complete", { orderID, total });

import { setPageProperties } from 'zeo-collect';

setPageProperties({ name: "Product" });

import { setUserProperties } from 'zeo-collect';

setUserProperties({ plan: "premium", country: "DEU" });

import { setUserIdentities } from 'zeo-collect';

setUserIdentities({
  email: "test@gmail.com",
  loginid: "testUser123",
  cellno: "1234890987"
});

setUserIdentities({
  email_sha256_lowercase: "...",
  cellno_with_country_code_sha256: "..."
});

setUserIdentities({ crmId: "12345" });

import { unSetUserIdentities } from 'zeo-collect';

unSetUserIdentities();

import { setConsent } from 'zeo-collect';

setConsent({ track: true, identify: true });

// with callback
setConsent({ track: true, identify: true }, (res) => {
  // handle response
});

import { listenToAskForConsent } from 'zeo-collect';

listenToAskForConsent(() => {
  // show your consent UI
});

import { pauseCollection, resumeCollection } from 'zeo-collect';

pauseCollection();
// ... no events sent in this window
resumeCollection();