OpenAI Conversions API

This destination is currently under final review and will be available soon.

OpenAI is artificial intelligence research organization. Using this destination you can can leverage OpenAI Conversions API to send conversion events directly to OpenAI for downstream attribution and reporting.

At present, OpenAI/ChatGPT Ads is in an early stage, and availability for businesses is limited. Moreover, the European Union is not yet whitelisted to leverage OpenAI Ads.

Key features

The OpenAI Conversions API destination provides the following key features:

• Events structure: our Events reference model covers OpenAI events, meaning that your data is properly bridged to the expected fields in an optimized way.

• Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.

• Automatic hashing: information is automatically hashed matching partner specifications.

• Smart mapping: data mapping can be readjusted using your datalayer defined fields.

• Event mapping: change standard mapping between OpenAI events and yours.

• Support for multi-item data: information included in the item array is dispatched to OpenAI.

• Support batch mode: send multiple events in one single request.

Destination setup

Ensure you have access to OpenAI Ads.

Event deduplication is peformed using id and type (see Field mappings) and the Pixel Id (See Configuration).

Configuration

Settings	Description
API Key	Required Your API key. You can contact OpenAI account team to get this value.
Pixel Id	Required Your pixel identifier. You can contact OpenAI account team to get this value.
Event Mapping	Change the standard mapping between OpenAI event types and your events. Accepted values for OpenAI event type : appointment_scheduled , checkout_started , contents_viewed , custom , items_added , lead_created , order_created , page_viewed , registration_completed , subscription_created and trial_started .

Quick reference

Commanders Act Events	OpenAI Event Types
appointment_scheduled	appointment_scheduled
checkout_started begin_checkout	checkout_started
contents_viewed	contents_viewed
custom	custom
items_added	items_added
lead_created generate_lead	lead_created
order_created purchase	order_created
page_view page_viewed	page_viewed
registration_completed sign_up	registration_completed
subscription_created	subscription_created
trial_started	trial_started
[Any Event]	[Any OpenAI Event Type] [1]

1. See Event Mapping in Configuration.

Field mappings

Properties can be remapped using our Smart Mapping feature.

Smart Mapping Fields

Commanders Act Default Properties

OpenAI Properties

Event Id	context.event_id	id [*]
-	(event_name)	type [1]
Event Timestamp	context.event_timestamp	timestamp_ms [2]
Custom Event Name	partners.openai.custom_event_name event_name	custom_event_name [3]
OpenAI Privacy Identifier	partners.openai.oppref	oppref
Action Source	type	action_source [4]
Page URL	context.page.url	source_url [5]
User Email	user.email	email_sha256 [6][7]
User Phone	user.phone	phone_number_sha256 [6][7]
User Id	user.id	external_id_sha256 [6][7] external_id [6]
User Country	user.country	country_sha256 [6][7]
User City	user.city	city_sha256 [6][7]
User ZIP Code	user.zipcode	zip_code_sha256 [6]
Device IP	context.device.ip	ip_address [6]
Device User Agent	context.device.user_agent	user_agent [6]
Opt-out	partners.openai.opt_out	opt_out
-	(event_name)	type [8]
Value	value	amount [8]
Currency	currency	currency [8]
Plan Identifier	partners.openai.plan_id	plan_id [8][9]
Item List	items	contents [8]
Item Id	items.X.id	contents.X.id [8]
Item Name	items.X.product.name	contents.X.name [8]
Item Content Type Content Type	items.X.content_type content_type	contents.X.content_type [8][10]
Item Price	items.X.product.price	contents.X.amount [8]
Item Quantity	items.X.quantity	contents.X.quantity [8]
Item Currency	items.X.currency	contents.X.currency [8][11]

* Mandatory property. 1. See Quick reference for more details. 2. If it's not passed, the current timestamp is used. 3. Set if type is custom . Default: value in event_name . 4. Accepted values: web , mobile_app , offline , physical_store , phone_call and email . Default: value in type . 5. Required if action_source is web . 6. Set in user . 7. Automatically normalized and hashed if passed in clear text. 8. Set in data when data.type is customer_action . 9. Set if data.type is custom or plan_enrollment . 10. Priority on the left. Default value: product . 11. Required if amount is set and currency (top level) is not set.