Understand and extend the web event schema

Updated Nov 8, 2026 · Based on Salesforce Developer documentation for Personalization (Event API, Interaction Definitions, Custom Events, Sitemap Implementation), retrieved 2026-11-08

Every action the Salesforce Interactions SDK reports — a page view, a click, or a custom action you define — travels to Personalization as one event object built around an interaction: a small record naming what the visitor did. Most page views are captured automatically; everything else you send yourself with one function call.

Send and extend events

1. Let the Sitemap capture page views automatically — no code needed on pages it already matches.
2. Track a click or other custom action by calling SalesforceInteractions.sendEvent() with an interaction object that has a name.
3. Attach product, cart, or order data to an interaction using the built-in CatalogObjectInteraction, CartInteraction, or OrderInteraction shapes instead of inventing your own fields.
4. Include a known identity (such as an email address) on the event’s user.identities field when you want it tied to a specific visitor.
5. Listen for OnBeforeEventSend during testing to inspect, or cancel, an event before it leaves the browser.

// Track a custom interaction when a visitor clicks a banner
SalesforceInteractions.listener("click", ".header-banner", () => {
  SalesforceInteractions.sendEvent({
    interaction: { name: "Banner Click" },
    user: { identities: { emailAddress: userEmail } },
  });
});