Configure destinations for Attentive (attributes)

Attentive API 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 Subscriptions and Custom Attributes endpoints to send custom profile attributes to Attentive API. 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 API 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 .

Important

Field names and field values are case sensitive in Attentive API. 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 API.

Get details

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

Detail 1.

Credential settings

API key

Required

The API key for your Attentive API account.

Detail 2.

Required configuration settings

Primary identifier

The primary identifier used within your Attentive API account. May be one of the following: “email” or “phone”.

Important

Attentive API 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.

Detail 3.

Sign-up units

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

Configure credentials

Configure credentials for Attentive API before adding a destination.

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

To configure credentials for Attentive API

Step 1.

From the Settings page, select the Credentials tab, and then click the Add credential button.

Step 2.

In the Credentials settings dialog box, do the following:

From the Plugin dropdown, select Attentive API.

Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.

Step 3.

The settings that are available for a credential vary by credential type. For the “attentive-api” credential type, configure settings, and then click Save.

API key

Required

The API key for your Attentive API account.

Add destination

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

To add a destination for Attentive API

Step 1.

Open the Destinations page, select the New destinations button, and then select Orchestration.

Add

To configure a destination for Attentive API, do one of the following:

  1. Click the row in which Attentive API is located. Destinations list alphabetically and you can scroll up and down the list.

  2. Search for Attentive API. Start typing “att”. The list filters to show only matching destinations. Select “Attentive API”.

Step 2.

Select the credential for Attentive API from the Credential dropdown, and then click Continue.

Tip

If there are any issues with destination connectivity, an error message will display in the destination setup dialog. If the destination saves successfully, the connection is ready for use.

Step 3.

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.

Step 4.

Configure the following settings, and then click “Save”.

Primary identifier

Enable verbose logging to return log details when Attentive API rejects adding contacts to the email list.

A list of rejected contacts returned by the response from ActiveCampaign lists each rejected contact with a contact identifier and a string that describes the rejection.

Important

Attentive API 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.

Step 5.

After configuring this destination users may use:

  • Orchestrations to send query results

  • Orchestrations and campaigns to send audiences

  • Orchestrations and campaigns to send offline events