Class Synerise

Logs an add-to-cart using Synerise's built-in product.addToCart event.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logAddedToCart({
  label: "Add to cart",
  sku: "SKU-123",
  finalPrice: 49.9,
  currency: "BRL",
  quantity: 2,
})
Copy

Logs a favorite using Synerise's built-in product.addToFavorite event.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logAddedToFavorites({
  label: "Add to favorites",
  data: { sku: "SKU-123" },
})
Copy

Logs a geographic appearance using Synerise's built-in client.location event.

The coordinates must be supplied by the Eitri-app — this call does not read the device's location. Obtain them through Eitri.geolocation first, respecting the permission flow.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logAppearedInLocation({
  label: "Store visit",
  latitude: -23.5505,
  longitude: -46.6333,
})
Copy

Logs an event with the Synerise SDK as a custom event, where each parameter of the event is defined as a key-value pair within the data object.

The eventName must follow Synerise's action grammar: a context.action form (for example screen.view, product.buy, social.share) of at most 32 characters. Names that do not match are dropped and logged natively, never truncated — a truncated action would register as a different event in the Synerise dashboard. This constraint is specific to Synerise; other SDKs receive event names verbatim.

Never send transaction.charge through this method — the vendor reserves it for the dedicated purchase event, which this integration does not expose.

Example:

const modules = await Eitri.modules();
const logEvent = modules?.synerise?.logEvent;
if (!logEvent) return;

await logEvent({
  eventName: "product.view",
  data: {
    sku: "sku-001",
    price: 29.99,
    currency: "BRL"
  }
})
Copy

Logs a product view using Synerise's built-in product.view event.

Prefer this over logEvent for the events below: the SDK owns the action name, so it is not subject to the context.action grammar or the 32-character limit, and the typed fields land in the slots Synerise's recommendation and segmentation engines actually read. Anything outside those slots goes in data and is sent as event parameters.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logProductView({
  label: "Product view",
  productId: "SKU-123",
  productName: "Tênis Runner",
  category: "Calçados",
})
Copy

Logs a cart removal using Synerise's built-in product.removeFromCart event.

Takes the same fields as logAddedToCart.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logRemovedFromCart({
  label: "Remove from cart",
  sku: "SKU-123",
  finalPrice: 49.9,
  currency: "BRL",
  quantity: 1,
})
Copy

Logs a search using Synerise's built-in client.search event.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logSearched({
  label: "tênis running",
  data: { results: 42 },
})
Copy

Logs a share using Synerise's built-in client.shared event.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logShared({ label: "Product shared" })
Copy

Logs a screen view using Synerise's built-in screen.view event.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.logVisitedScreen({ label: "ProductDetail" })
Copy

Updates the user's consent for mobile push campaigns.

The push token is resolved natively — it is not part of this call, and is not available to an Eitri-app.

If the device has no push token stored yet, the consent is persisted natively and sent to Synerise as soon as the token is registered, so it is never lost.

Example:

const modules = await Eitri.modules();
await modules?.synerise?.setUserOptins({ push: false })
Copy