X (Twitter) Conversion API

X CAPI, Twitter CAPI

X, also referred to by its former name Twitter, is a social media website. Using this destination you can share conversion data with X to enable the measurement of campaigns through Conversion API.

Key features

The X Conversion API destination provides the following key features:

• Events structure: our Events reference model matches X conversion 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.

Destination setup

Before using this destination, you need to create a new conversion event in Ads Manager or use an existing event already created and used with the Twitter Pixel.

To create a conversion event, access Ads Manager and navigate to Tools (1) → Events manager (2) :

If you do not have a Twitter Pixel event source, create it by selecting Add event source (3) :

The resulting identifier is your Pixel Id : See Configuration for more details. Now you can create an event by clicking Add events (4) :

The resulting identifier is you Event Id : See Configuration for more details. If you want to use an existing event that you're already using with the Twitter pixel, you can do so by getting its Event Id from the event list in the "Overview" tab.

X Conversion API supports deduplication with your client-side Twitter Pixel. Check the "Smart Mapping" field Transaction Id , Field Mappings (See property conversion_id ) or this LINK for more details (See section "Duplication between Pixel and Conversion API").

Configuration

Settings	Description
Authentication	Required Your credentials with Twitter as set in the Commanders Act interface following: Administration ➜ Connector Credentials ➜ Add connector credentials ➜ Twitter
Pixel Id	Required Your pixel identifier as created in Ads Manager (E.g. "o8z6j", without quotes). More details are available by following this LINK (See section "Steps" → "Creating the Conversion API event").
Event Id	Required Your event identifier as created in Ads Manager (E.g. "tw-o8z6j-o8z21", without quotes). More details are available by following this LINK (See section "Steps" → "Creating the Conversion API event").

Quick reference

Commanders Act Events	X Conversion Events
[Any Event] [1]	[Any Event] [2]

[1] Use Destination filters to specify your matching events. [2] See Event Id in Configuration for more details.

Field Mappings

Most properties can be remapped using our "Smart Mapping" feature. All X properties are set in the object conversions[0] . More details are available by following this LINK.

At least one of the following identifiers must be included: • Twitter click identifier (twclid) • Hashed email • Hashed E164 phone number When passing IP address or user agent, a second identifier needs to be provided. Having more values increases the match rate. More details are available by following this LINK (See section "Preparing Identifiers for Conversion Events").

Commanders Act Properties	X Properties
context.event_timestamp	conversion_time [*]
Event Id	event_id [*]
partners.twitter.twclid	identifiers.X.twclid [1]
user.email	identifiers.X.hashed_email [1]
user.phone	identifiers.X.hashed_phone_number [1]
context.device.ip	identifiers.X.ip_address [2]
context.device.user_agent	identifiers.X.user_agent [2]
items.length	number_items
currency	price_currency
value	value
id	conversion_id [3]
type	description
search_term	search_string
items.X.id	contents.X.content_id
items.X.product.group_id	contents.X.content_group_id
items.X.product.name	contents.X.content_name
items.X.product.price	contents.X.content_price
items.X.product.category_1 items.X.product.category_2 items.X.product.category_3 items.X.product.category_4 items.X.product.category_5	contents.X.content_type [4]
items.X.quantity	contents.X.num_items

[*] Mandatory property. [1] At least one of these properties must be provided. [2] A second identifier must be provided. [3] For deduplication purpose, ensure you use the same value with your Twitter Pixel. More details are available by following this LINK (See section "Duplication between Pixel and Conversion API"). [4] Categories are separated by the greater than (>) character.