Skip to main content
The Zeotap Collect Extension wraps the Web JS SDK. Every Action you compose in a Rule translates into a Web JS method call. This page maps the extension’s Action Types to those underlying methods.

Action Types

Available under Rules → Actions → Extension: Zeotap Collect → Action Type.
Action TypeDescriptionWeb JS method invoked
Load Zeotap SDKStamps the Zeotap JS on the page. Required as the first action in your initialization rule.(SDK bootstrap)
Set Custom ConsentSets primary or brand consent. Required if Consent Method is Custom. Also used for brand consent under any method.setConsent(...)
Sync User IdentitiesSets key-value pairs for User PIIs and Custom Identities.setUserIdentities(...)
Track EventSends an event. Pick Event Type: Page View, User Attributes, or Custom Event.setEventProperties / setPageProperties / setUserProperties

Track Event — Event Types

When you select Track Event as the Action Type, pick one of three Event Types.

Page View

Sends a page-view event. Set key-value pairs that describe the page (name, category, etc.). Invokes: setPageProperties({ name, category, ... }) When this rule is triggered, the configured key-value pairs are merged with any event attributes passed as a second argument to _satellite.track(directCall).

User Attributes

Attaches user-level attributes to the current zi and identities. Set key-value pairs for age, gender, plan tier, etc. You can add unlimited keys. Invokes: setUserProperties({ ... })
country and city are blacklisted for ingestion — Zeotap derives these from the IP address. See blacklisted fields.

Custom Event

Sends a named event with arbitrary properties.
  • Name — the event name.
  • Key-value pairs — properties attached to this event.
Invokes: setEventProperties(eventName, { ... })

Sync User Identities — accepted keys

Raw PII (with PII Hashing: “raw and hashed by Zeotap” or “raw and consumed as is”)

KeyDescription
fpuidFirst-party ID (CRM ID, DB ID).
emailUser’s raw email address.
cellnoCell number without country code.
cellno_ccCell number with country code.
loginidUser’s login ID.

Pre-hashed PII (with PII Hashing: “hashed by the customer”)

Email:
  • email_{sha256,sha1,md5}_{lowercase,uppercase}
Cell number (without country code):
  • cellno_without_country_code_{sha256,sha1,md5}
Cell number (with country code):
  • cellno_with_country_code_{sha256,sha1,md5}
Cell number (E.164 format):
  • cellno_e164_{sha256,sha1,md5}
Login ID:
  • loginid_{sha256,sha1,md5}_{lowercase,uppercase}

Custom identities

Any first-party identifier outside the reserved PII keys — crmID, ECID, visitorID, etc. Sent as-is. PII hashing flags don’t apply. See hashing guidelines for expected preprocessing.
FieldDescription
trackAllow event tracking. (Custom mode only)
identifyAllow user identification / ID+. (Custom mode only)
cookieSyncAllow partner cookie sync. (Custom mode only)
<brandConsent>Any brand-specific consent key (e.g. zeotapVendorConsent, xyzVendorConsent). Honored under any consent method.
For consent strategy details, see Configuration → Consent Method. When the extension fires a cookie sync, the request looks like:
https://spl.zeotap.com/fp?cmp=1&cookieSync=true&gdpr=1&gdpr_consent=...&identify=true&optin=yes&payload=...&track=true&w_k=...
Consent flags:
Query parameterDescription
optinWhether the SDK has consent for any action.
trackConsent to track event or user data.
identifyConsent to identify the user via ID+ 1P cookie.
cookieSyncConsent to sync cookies with partners.
cmp1 if consent was resolved via TCF API; 0 otherwise.
gdpr_consentTCF v2 consent string (TCF mode).
General:
Query parameterDescription
w_kEncoded write_key of the Source.
payloadEncoded identities passed to Zeotap JS — User PIIs, custom identities, default 1P cookies.
The response is a list of image pixel tags with URLs for the cookie syncs to fire.
Last modified on June 22, 2026