Configuring the Message application in Eloqua:
- Begin by logging into your Eloqua account
- Create a Multi-Step Campaign under the campaigns button on your dashboard
- Open a blank campaign
-
User will be directed to a new campaign canvas. To begin, drag and drop a ‘Segment Members’ step into the campaign canvas
-
Double click within the Segment Members step to select the desired audience
- Click the arrow next to 'Campaign Steps' on the left of the page to view all available campaign steps
- Scroll down to the bottom of the Campaign Steps list and drag the 'Message: Twilio' application onto the campaign canvas
- Double click the Message step on the campaign canvas and click the pencil icon on the pop window
- A screen will appear that will take you to a login page for the Incindio platform
- Login using Incindio platform credentials. Once logged in, the user will be taken to the first step of the app configuration screen
- Begin by naming the configuration (the Configuration Name will be logged with all returning message data. This allows the user Configuration Name to easily sort, report, or segment on data in Eloqua)
- Next, choose the corresponding Eloqua Instance from the dropdown menu by clicking the arrow in the Eloqua Credentials field
- The following fields are used to customize how the Notification is served to users
- Notification Priority
The priority of the notification. Can be:low
orhigh
and the default ishigh
. A value oflow
optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM,low
priority is the same asNormal
priority. For APNSlow
priority is the same as5
. A value ofhigh
sends the notification immediately, and can wake up a sleeping device. For FCM and GCM,high
is the same asHigh
priority. For APNS,high
is a priority10
. - Notification Life Span
This field defines how long the notification is valid. Delivery should be attempted if the device is offline until the TTL elapses. Instant Only, means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. - Sound
The name of the sound to be played for the notification. For FCM and GCM, this Translates todata.twi_sound
. For APNS, this translates toaps.sound
.
- Notification Priority
- Next, users will configure the notification Title and Message the users will receive.
- Notification title will appear at the top of the Push Notification and on certain devices may be bolded.
- Notification Body is where users can configure the main content of the push notification.
- Users may merge Contact Fields and Custom Object Fields in the message content by selecting the desired field in the corresponding dropdown menus.
When a field is selected, a token for that field will be added into the Message Content box. When the text message is sent, the token will be replaced with the data designated for each individual contact for that field. - The last field in this configuration section, allows the user to define which app actions may be included with the Push Notification
The actions to display for the notification. For APNS, translates to theaps.category
value. For GCM, translates to thedata.twi_action
value. - Users may also enable the "Addtional Data Payload" section to include additional meta data with the push notification
Available fields in the Additional Data Payload include:- Data
The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates todata
in the FCM and GCM payloads. FCM and GCM reserve certain keys that cannot be used in those channels. For APNS, attributes ofdata
are inserted into the APNS payload as custom properties outside of theaps
dictionary. In all channels, we reserve keys that start withtwi_
for future use. Custom keys that start withtwi_
are not allowed and are rejected as 400 Bad request with no delivery attempted. - APN
The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNSPayload
item, therefore theaps
key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. Custom keys that start withtwi_
are not allowed. - GCM
The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. Target parametersto
,registration_ids
, andnotification_key
are not allowed. Custom keys that start withtwi_
are not allowed. - FCM
The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. Target parametersto
,registration_ids
,condition
, andnotification_key
are not allowed in this parameter. Custom keys that start withtwi_
are not allowed. FCM also reserves certain keys, which cannot be used in that channel.
- Data
- Click Next to continue to the next page
- The second page of the application is where the User will map the Eloqua Contact fields required by the application, as well as the CDO fields used to log all notifications sent by the application
- The Phone Bindings field is the Eloqua contact field that contains the Users Twilio Identify.
- Service Sid: Select the Twilio Service in the linked Twilio account that will be service the Push Notifications
- Select the Eloqua Custom Object that will be used to log Push Notification activity. (If this has not been created contact your Sureshot CSM)
- Map each field to its corresponding CDO field. Each Notification sent will be written as a new record in the Selected CDO containing the above information.
- Click "Submit" to save your configuration
- After clicking 'Submit' on the configuration you'll receive a green 'Success' message, and the configuration has now been completed.
- Users may now activate the Eloqua campaign and move contacts into the cloud action step to trigger a Push Notification.