Skip to main content

Criteo Events API

Server Source code Package Beta

Server-side event delivery to Criteo's Events API (S2S v0) for reliable retargeting, bypassing browser limitations and providing consistent user matching for ad optimization.

Where this fits

Criteo Events API is a server destination in the walkerOS flow:

Sends events server-side to Criteo using raw HTTP (no SDK). Authentication is in-payload (`account` = Partner ID, `id.mapping_key` = Caller ID). Emails are hashed into MD5, SHA-256, and SHA-256(MD5) before sending.

Installation

Loading...
Loading...

Configuration

This destination uses the standard destination config wrapper (consent, data, env, id, ...). For the shared fields see destination configuration. Package-specific fields live under config.settings and are listed below.

Settings

PropertyTypeDescriptionMore
partnerId*stringCriteo Partner ID (numeric string, provided by Criteo)
callerId*stringCaller ID for user mapping (provided by Criteo)
siteType'd' | 'm' | 't'Site type: d (desktop), m (mobile web), t (tablet)
countrystringISO 3166-1 alpha-2 country code
languagestring2-letter language code
urlstringCustom Events API endpoint (default https://widget.criteo.com/m/event?version=s2s_v0)
user_dataRecord<string, string>Mapping for identity fields
* Required fields

Mapping

Per-event rules under config.mapping. For the standard rule fields (consent, condition, data, batch, name, policy) see mapping.

PropertyTypeDescriptionMore

Examples

add to cart

Event
Mapping
Out

page view

Event
Mapping
Out

purchase

Event
Mapping
Out

view item

Event
Mapping
Out

Event mapping

Criteo uses its own standard event names. Set the Criteo event name via each rule's name field.

walkerOS EventCriteo Event Name
page viewviewHome / viewPage
product viewviewItem
product listviewList
product addaddToCart
cart viewviewBasket
checkout startbeginCheckout
checkout paymentaddPaymentInfo
order completetrackTransaction
user loginlogin
Loading...

User identity

Criteo matches users via three signals. Wire them through user_data in settings:

FieldDescription
mapped_user_idCriteo GUM ID
emailRaw email. Hashed into MD5, SHA-256 and SHA-256(MD5)
retailer_visitor_idStable retailer visitor identifier
Loading...

Email hashing

Raw emails are lowercased and trimmed, then hashed into all three formats Criteo expects:

  • md5: MD5 hex digest
  • sha256: SHA-256 hex digest
  • sha256_md5: SHA-256 hex of the MD5 hex string

Pre-hashed values (detected by hex length: 32 chars for MD5, 64 for SHA-256) are passed through without re-hashing.

Deduplication

Criteo Events API supports deduplication with Criteo OneTag by sharing a deduplication_page_view_id across channels. Wire it via data.map.deduplication_page_view_id in the event mapping.

💡 Need implementation support?
elbwalker offers hands-on support: setup review, measurement planning, destination mapping, and live troubleshooting. Book a 2-hour session (€399)