Twitter event forwarding extension

Twitter is an online social media and social networking service, on which users post and interact with 280-character-long messages known as tweets. Users can interact with Twitter using a browser, mobile frontend software, or programmatically through its APIs

The Twitter Web Conversions API event forwarding extension allows you to leverage data captured in the Adobe Experience Platform Edge Network and send it to Twitter. This document covers the use cases of the extension, how to install it, and how to integrate its capabilities into your event forwarding rules.

Twitter requires OAuth 1.0 for authentication with the Twitter Web Conversions API.

Use cases

This extension should be used if you want to use data from the Edge Network in Twitter to take advantage of its customer analytics and targeting capabilities.

For example, consider a marketing team in an organization. The team captures user interaction event data from their website as event data from their website and loads it into Twitter using this event forwarding extension.

The marketing and analytics teams can then leverage Twitter’s capabilities to perform additional analysis and target these users for targeted advertisement campaigns.

For more information on use cases specific to Twitter, refer to the Twitter use cases documentation.

Twitter prerequisites and guardrails prerequisites

You must have a valid Twitter account in order to use this extension. Go to the Twitter registration page to register and create an account if you do not have one already.

You must set up your account as a Twitter developer account. To find out how to sign up as a developer, refer to the Twitter developer account.

API guardrails guardrails

The Twitter Web Conversions API has a rate limit of 60,000 requests per 15 minute interval, where each request allows 500 events.

Gather required configuration details configuration-details

In order to connect the Experience Platform to Twitter, the following inputs are required:

Key Type
Description
Consumer Key
​ The app’s API Key for accessing the Twitter API. Refer to the Twitter documentation on api keys and secrets for guidance.
Consumer Secret
The API Secret allows your app to access the Twitter API. Refer to the Twitter documentation on api keys and secrets for guidance.
Token Secret
The non-expiring token secret of your app, which is used for authenticating to the Twitter API via OAuth. Refer to the Twitter documentation on obtaining use access tokens for guidance.
Access Token
The non-expiring access token of your app, which is used for authenticating to the Twitter API via OAuth. Refer to the Twitter documentation on obtaining use access tokens for guidance.
Pixel Id
The Twitter Pixel is a website tag that is implemented on your website to track site actions or conversions. Refer to the Twitter documentation on conversion tracking for websites for guidance.

Install and configure the Twitter extension install

To install the extension, create an event forwarding property or choose an existing property to edit instead.

Select Extensions in the left navigation. In the Catalog tab, select Install on the card for the Twitter extension.

Catalog showing the Twitter extension highlighting install.

IMPORTANT
Depending on your implementation needs, you may need to create a schema, data elements, and a dataset before configuring the extension. Please review all the configuration steps before starting in order to determine which entities you need to set up for your use case.

On the next screen, input the following configuration values that you previously gathered from Twitter:

  • Pixel Id
  • Consumer Key
  • Consumer Secret
  • Token
  • Token Secret

When finished, select Save.

Twitter configuration screen for the Twitter extension.

Configure an event forwarding rule config-rule

Once all your data elements are set up, you can start creating event forwarding rules that determine when and how your events will be sent to Twitter.

Create a new rule in your event forwarding property. Under Actions, add a new action and set the extension to Twitter. To send Edge Network events to Twitter, set the Action Type to Send Web Conversion.

After selection, additional controls appear to further configure the event. You need to map the Twitter event properties to the data elements that you previously created. For more information, refer to the Twitter Web Conversions API.

The Twitter creating a conversion event rule.

User Identification

Field name
Description
Example
Required
Twitter Click ID
Twitter Click ID as parsed from the click-through URL.
26l6412g5p4iyj65a2oic2ayg2
Required if no other identifier is added.
Email
An email address hashed with SHA256. The text must be lowercase and any trailing or leading spaces must be removed before hashing.
eventforwarding@example.com
Required if no other identifier is added.
Phone
Phone serves as an identifier to match the conversion event. The phone number must be in E164 format [+][country code][area code][local phone number] before hashing.
+911234567875
Required if no other identifier is added.

Conversion Data

Field name
Description
Example
Required
Conversion Time
Date-time as string in ISO 8601 or in yyyy-MM-dd'T'HH:mm:ss:SSSZ format.
2022-02-18T01:14:00.603Z
Yes
Event Id
The base-36 ID of a specific event. This Id should match a pre-configured event contained within your Twitter ad account. This is known as the ID for the corresponding event in Events Manager.
o87ne or tw-o8z6j-o87ne (tw-pixel_id-event-id)
Yes
Number of Items
The number of items being purchased in the event. This must be a positive number greater than 0.
4
No
Currency
The currency of the items being purchased in the event. This is expressed in ISO-4217 and if not provided, the default will be USD.
USD
No
Value
The price value of items being purchased in the event.
100.00
No
Conversion ID
An identifier for a conversion event that can be used for de-duplication between Web Pixel and Conversion API conversions in the same event tag.
23294827
No
Description
A description with any additional information on the conversions.
Test conversion
No

Validate data within Twitter

Once the event forwarding rule has been created and executed, validate whether the event that was sent to the Twitter API is displayed as expected in the Twitter UI.

If the event collection and Experience Platform integration were successful, you will see events within the Twitter Events manager.

The Twitter event manager

Next steps

This guide covered how to send conversion events to Twitter using event forwarding. For more information on these underlying technologies, refer to the official documentation:

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743