Pull from Listrak¶

Listrak enables personalized cross-channel interactions that help automate campaigns, build customer loyalty, and increase conversion rates.

Use the Listrak Email API and Listrak SMS API to pull email and/or SMS profiles from Listrak to Amperity.

This topic describes the steps that are required to pull email and/or SMS profiles to Amperity from Listrak:

Get details
Add courier
Run courier
Review feed and domain table
Add to courier group

How this source works¶

Amperity can pull email and/or SMS profiles from Listrak.

Pull email and SMS contact lists to Amperity from Listrak.

A Listrak data source works like this:

Configure Amperity to pull one (or both) of the following data sources:

Email subscription status using the Listrak Email API .

SMS profiles, opt-in / opt-out status, and subscription status using the Listrak SMS API .

Important

You may configure one or both of these data sources.
Amperity pulls data from Listrak using REST APIs, and then loads this data to Amperity as a feed that automatically assigns semantic tags to fields that contain customer PII.
Domain tables within Amperity are refreshed.
Customer profiles are made available to Stitch. All data is passed to your customer 360 database. The Amperity ID links records across data sources for each unique customer.

Get details¶

Listrak requires the following configuration details:

The client ID(s) and secret(s) for the Listrak Email API and/or Listrak SMS API . (You must configure at least one of email or SMS and may configure both.)

Important

The Amperity IP address for allowlists must also be added to the allowlist in Listrak.
The Email list name and/or SMS list name. (This depends on which REST APIs are configured.)

Important

For SMS integrations with more than one provisioned short code, a list that matches the provided name should exist for each short code.

Tip

Use SnapPass to securely share configuration details for Listrak between your company and your Amperity representative.

Add courier¶

A courier brings data from an external system to Amperity.

Important

A courier can be configured to pull email AND / OR SMS data from Listrak to Amperity. When pulling email AND SMS data both email and SMS client ID and secret fields must be present in the selected credential, additionally both list names must be provided. When pulling just one data source only the corresponding client ID, secret and list name must be provided.

To add a courier

From the Sources page, click Add Courier. The Add Source page opens.
Find, and then click the icon for Listrak. The Add Courier page opens.

This automatically selects listrak as the Credential Type.
Enter the name of the courier. For example: “Listrak”.
From the Credential field, select an existing credential or select Create a new credential.

To add a credential, enter the name of the credential, a description, the Listrak client ID(s) and client secret(s). Click Save.
Under Settings enter the the list name for each integration being used, as defined in Listrak.
Under Select Data, enable Email Contacts AND / OR SMS Contacts.
Click Create.

Run courier manually¶

Run the courier again. This time, because the load operations are present and the feeds are configured, the courier will pull data from Listrak.

To run the courier manually

From the Sources tab, open the menu for the courier with updated load operations that is configured for Listrak, and then select Run. The Run Courier dialog box opens.
Select the load option, either for a specific time period or all available data. Actual data will be loaded to a domain table because the feed is configured.
Click Run.

This time the notification will return a message similar to:
```
Completed in 5 minutes 12 seconds
```

Review feed and domain table¶

After running the Listrak courier a feed is created automatically with a pre-defined list of fields. You may apply semantic tags to these fields and you may make the domain table available to Stitch, depending on your use cases. A domain table named Listrak:EmailContacts AND / OR Listrak:SmsContacts will be added.

Email¶

The feed and domain table will match the fields defined in the Listrak Email API :

emailAddress (assigned the email and ck semantic tags)
subscribeDate
subscribeMethod
unsubscribeDate
unsubscribeMethod

SMS¶

The feed and domain table will match the fields defined in the Listrak SMS API :

birthday (assigned the birthdate semantic tag)
emailAddress (assigned the email and ck semantic tags)
firstName (assigned the given-name semantic tag)
lastName (assigned the surname semantic tag)
phoneNumber (assigned the phone and ck semantic tags)
postalCode (assigned the postal semantic tag)
optedOut
subscribeDate
unsubscribeDate

Add to courier group¶

A courier group is a list of one (or more) couriers that are run as a group, either ad hoc or as part of an automated schedule. A courier group can be configured to act as a constraint on downstream workflows.

To add the courier to a courier group

From the Sources tab, click Add Courier Group. This opens the Create Courier Group dialog box.
Enter the name of the courier. For example: “Listrak”.
Add a cron string to the Schedule field to define a schedule for the orchestration group.

A schedule defines the frequency at which a courier group runs. All couriers in the same courier group run as a unit and all tasks must complete before a downstream process can be started. The schedule is defined using cron.

Cron syntax specifies the fixed time, date, or interval at which cron will run. Each line represents a job, and is defined like this:
```
┌───────── minute (0 - 59)
│ ┌─────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌────────────── month (1 - 12)
│ │ │ │ ┌─────────────── day of the week (0 - 6) (Sunday to Saturday)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * * command to execute
```
For example, 30 8 * * * represents “run at 8:30 AM every day” and 30 8 * * 0 represents “run at 8:30 AM every Sunday”. Amperity validates your cron syntax and shows you the results. You may also use crontab guru to validate cron syntax.
Set Status to Enabled.
Specify a time zone.

A courier group schedule is associated with a time zone. The time zone determines the point at which a courier group’s scheduled start time begins. A time zone should be aligned with the time zone of system from which the data is being pulled.

Use the Use this time zone for file date ranges checkbox to use the selected time zone to look for files. If unchecked, the courier group will use the current time in UTC to look for files to pick up.

Note

The time zone that is chosen for an courier group schedule should consider every downstream business processes that requires the data and also the time zone(s) in which the consumers of that data will operate.
Add at least one courier to the courier group. Select the name of the courier from the Courier drop-down. Click + Add Courier to add more couriers.
Click Add a courier group constraint, and then select a courier group from the drop-down list.

A wait time is a constraint placed on a courier group that defines an extended time window for data to be made available at the source location.

Important

A wait time is not required for a bridge.

A courier group typically runs on an automated schedule that expects customer data to be available at the source location within a defined time window. However, in some cases, the customer data may be delayed and isn’t made available within that time window.
For each courier group constraint, apply any offsets.

A courier can be configured to look for files within range of time that is older than the scheduled time. The scheduled time is in Coordinated Universal Time (UTC), unless the “Use this time zone for file date ranges” checkbox is enabled for the courier group.

This range is typically 24 hours, but may be configured for longer ranges. For example, it’s possible for a data file to be generated with a correct file name and datestamp appended to it, but for that datestamp to represent the previous day because of how an upstream workflow is configured. A wait time helps ensure that the data at the source location is recognized correctly by the courier.

Warning

This range of time may affect couriers in a courier group whether or not they run on a schedule. A manually run courier group may not take its schedule into consideration when determining the date range; only the provided input day(s) to load data from are used as inputs.
Click Save.