Send data to Attentive

Attentive Mobile is a personalized mobile messaging platform that improves brand engagement with mobile consumers.

Amperity can manage an audience in Attentive Mobile and attributes about that audience.

1. Send audience segments to Attentive Mobile using a SFTP-based process.

2. Send customer attributes about that audience using the Custom Attributes API.

How this destination works

Amperity can manage audiences in Attentive Mobile and provide attributes about the customers who belong to those audiences. A segment is the list of customers to which you will send emails or messages. A subscriber is a customer for which you have an opt-in/out status. You can only send emails or messages to customers who have opted-in.

An Attentive Mobile destination works like this:

1. Use a query or segment to a) build a list of subscribers for whom you have opt-in/out data, and then b) build a segment that contains a list of customers to whom you want to send email or SMS messages.

2. Configure destinations that manage audience segments, and then provide attributes about the customers who belong to those audiences.

   Why are there two ways to send data to Attentive?

   Amperity uses the Subscriptions and Custom Attributes API endpoints in the Custom Attributes API to manage subscribers. Updates appear on the Subscribers page within your audience in Attentive Mobile.

   Amperity uses the subscriber segment upload process to manage segments. This process does not use an endpoint and is not subject to Attentive API rate limits . Updates appear on the Segments page within your audience in Attentive Mobile.

3. Send a test from Amperity, and then from within Attentive Mobile verify that the Subscribers page has the updated subscriber opt-in/out status and that the Segments page has the list of customers that you sent from Amperity.

Audience segments

Amperity uses the subscriber segment upload process to manage segments. This process does not use an endpoint and is not subject to Attentive API rate limits . Updates appear on the Segments page within your audience in Attentive Mobile.

Note

Changes to audiences are not immediately available in Attentive Mobile. Allow for up to 24 hours after the point at which Amperity has finished sending audience updates for them to be available.

This topic describes the steps that are required to send audiences to Attentive Mobile from Amperity:

1. Get details

2. Add destination

3. Add data template

Get details

Attentive Mobile requires the following configuration details for sending audience segments:

1. The username and passphrase with permission to write data to Attentive Mobile using their SFTP process.

2. The remote folder to which Amperity will send data: /uploads.

3. The public key to use for PGP encryption, if required.

4. Review the subscriber segment upload topic for specific requirements for how to format the CSV file.

5. Do not include header rows in output.

Add destination

Configure Amperity to send audiences directly to Attentive Mobile.

Important

Be sure to use “Segments” in the destination title so that users of Amperity who will send segments to Attentive Mobile will be able to identify this destination. Review the subscriber segment upload topic for specific requirements for how to format the CSV file. Do not include header rows in output.

To add a destination

1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

2. Enter the name of the destination and a description. For example: “Attentive Mobile” and “This sends query results to “Attentive Mobile”.

3. From the Plugin drop-down, select Attentive Mobile.

   This automatically selects attentive mobile as the Credential Type and assigns sftp.attentivemobile.com as the location to which data is sent.

4. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box. Enter a name for the credential (typically “Attentive Mobile”), and then enter the username and password required to access this SFTP location.

5. Under Settings, enter the path to the remote folder.

   Tip

   For remote folders that contain spaces, use a backslash (\) character to escape the space. For example, a folder named “From ACME” should be entered as “FromACME”.

6. From the File Format drop-down, select CSV.

7. Add a single character to be used as an escape character in the output file. (This should match the escape character required by Attentive Mobile.)

   Note

   If an escape character is not specified and quote mode is set to “None” this may result in unescaped, unquoted files. When an escape character is not specified, you should select a non-“None” option from the Quote Mode setting.

8. Specify the encoding method. Encoding method options include “Tar”, “Tgz”, “Zip”, “GZip”, and “None”.

9. Optional. Add the PGP public key that is used to encrypt files sent to Attentive Mobile.

10. Optional. Specify the line ending type: LF or CRLF.

11. Optional. Set the quote mode.

    Note

    If the quote mode is set to “None” and the Escape Character setting is empty this may result in unescaped, unquoted files. When quote mode is “None”, you should specify an escape character.

12. Optional. Select Include success file upon completion to add a .DONE file to indicate when an orchestration has finished sending data.

    Tip

    If a downstream sensor is listening for files sent from Amperity, configure that sensor to listen for the presence of the .DONE file.

13. Optional. Select Include header row in output files if headers are included in the output.

14. Select Allow business users to use this destination.

    This allows users who have been assigned to the Amp360 User and/or AmpIQ User policies to use this destination with orchestrations and/or campaigns.

15. Select Allow business users with limited PII access to send data. (A business user with limited PII access is someone who has been assigned the Restrict PII Access policy option.)

16. Click Save.

Custom attributes (API)

Attentive Mobile is your source of truth for your customers’ subscription status, while Amperity is your source of truth for profile attributes that describe those customers.

Amperity uses the Custom Attributes API endpoint to send custom profile attributes to Attentive Mobile. Use these attributes to apply customizable data or characteristics to each of your subscribers, and then use that information to build segments for use with campaigns and journeys.

Caution

The Attentive Mobile Custom Attributes API allows you to build segments based on a match with customer profile attributes. Custom attributes cannot contain any sensitive or special categories of information .

This topic describes the steps that are required to send audiences to Attentive Mobile from Amperity:

1. Get details

2. Add destination

3. Add data template

Get details

The Attentive Mobile Custom Attributes API requires the following configuration details for sending audience subscribers:

1. The Attentive Mobile API key.

2. The ID for the sign-up unit . Sign-up units are managed from the Sign-up Units page in Attentive Mobile. You must provide an ID for an active sign-up unit.

Add destination

Configure Amperity to send audiences directly to Attentive Mobile.

Important

Attentive Mobile accepts email addresses or phone numbers as the primary identifier. The set of data that is sent from Amperity must contain the primary identifier. For example, if your primary identifier is phone numbers, than the phone field must be included.

You may send the non-primary email address or phone number as a custom attribute.

To add a destination

1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

2. Enter the name of the destination and a description. For example: “Attentive Mobile” and “This sends audiences to Attentive Mobile”.

3. From the Plugin drop-down, select Attentive Mobile.

4. The “Attentive API” credential type is selected automatically.

5. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box.

6. Enter a name for the credential along with the Attentive API key, sign-up unit ID, and primary identifier. Click Save.

7. Select Allow business users to use this destination.

   This allows users who have been assigned to the Amp360 User and/or AmpIQ User policies to use this destination with orchestrations and/or campaigns.

8. Select Allow business users with limited PII access to send data.

   This allows users who have been assigned to the Restrict PII Access policy option to use this destination with orchestrations and/or campaigns.

9. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

To add a data template

	From the Destinations tab, open the menu for a destination that is configured for Attentive Mobile, and then select Add data template. This opens the Add Data Template dialog box. From the Destinations tab, open the menu for a destination that is configured for Attentive Mobile, and then select Add data template. This opens the Add Data Template dialog box.
	Verify business user access to queries and orchestrations and access to segments and campaigns. A business user may also have restricted access to PII, which prevents them from viewing and sending customer profile data. If business user access was not configured as part of the destination, you may configure access from the data template. Important To allow business users to use this destination with campaigns, you must enable the Make available to campaigns option. This allows users to send campaign results from Amperity to Attentive Mobile. If you enable this option, the data extension settings require using campaign name and group name template variables to associate the name of the data extension to your campaign.
	Verify all configuration settings. Note When the settings required by Attentive Mobile were are not configured as part of the destination, you must configure them as part of the data template before making this destination available to campaigns.
	Review all settings, and then click Save. After you have saved the data template, and depending on how you configured it, business users can send query results to Attentive and/or send campaigns to Attentive to Attentive Mobile.

About filename templates

A filename template defines how the names of segments and campaigns will appear in Attentive Mobile.

The following table shows how your segment name will appear in Attentive Mobile. These examples represent a one-time buyer campaign that is attempting to win a second purchase. The campaign is named “Winback” and it has sub-audiences for “Dress Shirts”, “Jeans”, and “Shoes”. Keep these types of patterns in mind when naming campaigns, recipient groups, and sub-audiences within your campaigns that will be sent to Attentive Mobile.

Pattern	Segment name(s)	Description
(empty)	WinbackDressShirts WinbackJeans WinbackShoes	An empty filename template setting is the equivalent of {{ campaign_name }}{{ group_name }}.
campaign_name	Winback	Use this pattern for campaigns that do not have more than one recipient group or sub-audiences. This will use the name of the campaign as the name of the segment in Attentive Mobile. Tip Use {{ campaign_name }} instead of {{ list_name }}.
campaign_name + group_name	Winback_DressShirts Winback_Jeans Winback_Shoes	Use this pattern for campaigns that have more than one recipient group and/or have sub-audiences. You may use an underscore (_) or a hyphen (-): {{ campaign_name }}_{{ group_name }} or {{ campaign_name }}-{{ group_name }}. You may put them next to each other (without using an underscore or hyphen): {{ campaign_name }}{{ group_name }}. You may switch the ordering: {{ group_name }}_{{ campaign_name }}. Tip Be sure to use descriptive names for campaigns and recipient groups and be careful to not use the default recipient group names when sending campaigns to Attentive Mobile. This will ensure that downstream users in Attentive Mobile will be able to understand what each segment is for and won’t have to view default naming patterns like “Winback_Recipient1”, “WinbackRecipient2”, etc.
group_name	DressShirts Jeans Shoes	Use this pattern to only use the names of recipient groups as segment names in Attentive Mobile. This will omit the name of the campaign and the name of the sub-audience from the segment name.

Important

The filename template, as used with Attentive Mobile (and unlike how it is used with other destinations), does not build a file name. Instead the filename template defines which strings (campaign and/or recipient group) will be used as the name of a segment in Attentive Mobile. Spaces in campaign and recipient group names are removed.