Send custom attributes to Attentive

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 Subscriptions and Custom Attributes endpoints 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 allows you to build segments based on a match with customer profile attributes. Custom attributes cannot contain any sensitive or special categories of information .

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.

Detail 1.

Credential settings

API key

Required

The API key for your Attentive account.

Detail 2.

Required configuration settings

Primary identifier

The primary identifier that is 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 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.

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 will configure 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.

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 are determined by the 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 test audience, and then verify the the results in Attentive. After the end-to-end workflow has been verified, push the destination from the sandbox to production.

To add a destination for Attentive API

Step 1.

Open the Destinations page, and then click the Add destination button.

Add

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

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

  2. Search for Attentive. Start typing “att”. The list will filter to show only matching destinations. Select “attentive-api”.

Step 2.

Select the credential for Attentive from the Credential drop-down, and then click Continue.

Tip

Click the “Test connection” link on the “Configure destination” page to verify that Amperity can connect to Attentive.

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 users with limited access to PII access to this destination.

Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow.

Step 4.

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

Primary identifier

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

When verbose logging setting is enabled, a list of rejected contacts is returned by the response from ActiveCampaign. For each rejected contact, a contact identifier is provided along with a string that describes the reason why the contact was rejected.

Important

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

Step 5.

After this destination is configured, users may configure Amperity to:

  • Use orchestrations to send query results

  • Use orchestrations and campaigns to send audiences

  • Use orchestrations and campaigns to send offline events

to Attentive.