Configure campaigns for Attentive (attributes)

Attentive 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 Bulk attribute endpoint to send custom profile attributes to Attentive. 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 Custom Attributes API builds segments based on a match with customer profile attributes. Custom attributes cannot contain any sensitive or special categories of information .

Important

Field names and field values are case sensitive in Attentive. For example, field names like “Favorite color” and “Favorite Color” are treated as different custom attributes and field values like “Blue” and “blue” are treated as different values.

Queries that are run in performance mode automatically convert field names to lowercase. If a query must be run in performance mode, consider using the LOWER() function to ensure consistent capitalization is applied to field names.

Why are there two ways to send data to Attentive?

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.

Get details

Review the following details before configuring credentials for Attentive and before configuring Amperity to send custom attributes to Attentive.

Credential settings API key Required The API key for your Attentive account. The API key must be associated with a custom app that has the following permissions: Custom Attributes: All Subscribers: All If these permissions are not set, any workflow that sends data to Attentive will fail with a 403 error. To update permissions for Amperity as an existing custom app in Attentive: Sign in to the Attentive dashboard. In the sidebar, click Marketplace. Open the Built by you tab. Select the custom app named “Amperity”. Important Do not select “Amperity CAPI,” “Amperity Events,” or any similarly named app. Under Permissions, set Custom Attributes and Subscribers to All, then click Save. See Create and manage custom apps in the Attentive documentation for more information.

Required configuration settings Primary identifier The primary identifier used within your Attentive account. May be one of the following: “email” or “phone”. Important Attentive accepts email addresses or phone numbers as the primary identifier. The set of data sent from Amperity must contain the primary identifier. For example, if your primary identifier is phone numbers, than include the phone field. You may send the non-primary email address or phone number as a custom attribute.

Configure credentials

Configure credentials for Attentive before adding a destination.

An individual with access to Attentive should use SnapPass to securely share “API key” details with the individual who configures Amperity.

To configure credentials for Attentive API

	From the Settings page, select the Credentials tab, and then click the Add credential button.
	In the Credentials settings dialog box, do the following: From the Plugin dropdown, select Attentive. Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.
	The settings that are available for a credential vary by credential type. For the “Custom Attributes API” credential type, configure settings, and then click Save. API key Required The API key for your Attentive account.

Add destination

Use a sandbox to configure a destination for Attentive. Before promoting your changes, send a sample audience, and then verify the results in Attentive. After verifying the end-to-end workflow, push the destination from the sandbox to production.

To add a destination for Attentive API

	Open the Destinations page, select the New destinations button, and then select Campaign. To configure a campaign for Attentive, do one of the following: Click the row in which Attentive is located. Destinations list alphabetically and you can scroll up and down the list. Search for Attentive. Start typing “att”. The list filters to show only matching destinations. Select “attentive-api”.
	Select the credential for Attentive from the Credential dropdown, and then click Continue. Tip Amperity validates the connection when the destination is saved. If the connection cannot be validated, an error is shown and the destination is not saved.
	In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination. Configure business user access By default a destination is available to all users who have permission to view personally identifiable information (PII). Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies. Enable the PII setting checkbox to allow limited access to PII for this destination. Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.
	Configure the following settings, and then click “Save”. Primary identifier The primary identifier used within your Attentive account. May be one of the following: “email” or “phone”. Important Attentive accepts email addresses or phone numbers as the primary identifier. The set of data sent from Amperity must contain the primary identifier. For example, if your primary identifier is phone numbers, than include the phone field. You may send the non-primary email address or phone number as a custom attribute. Campaign file settings Under Campaign settings select one of the following: Send audience list as separate files This option sends a standalone file for each treatment group sending an audience to Attentive. Send audience lists as a single file This option consolidates all treatment groups into a single file before sending the audience to Attentive.
	After configuring this destination users may send campaigns to Attentive.
	Validate the audience with Attentive by using a sample audience with a very small membership. For example: 10 or 100 members or the minimum audience size recommended by Attentive. Send the sample audience to Attentive and verify the sample audience is correct in Attentive. Make adjustments if necessary. Only send full audiences after validation is complete.