Listrak (real-time)

Send a Listrak transactional message to a single customer as soon as Amperity sees the customer interaction. Each destination sends on one channel:

  • email requests a transactional email, using the Send a Transactional Message endpoint of the Listrak Email API. Other attributes that you map are sent as profile field values to personalize the message.

  • sms requests a transactional SMS message, using the Send Transactional Message endpoint of the Listrak SMS API.

Amperity sends the ID of the transactional message and the recipient. It does not send message content; set up the message in Listrak.

To manage email lists on a schedule rather than in real time, use the Listrak Email destination.

This connector is named Listrak in Amperity and sends from a real-time journey. See Real-time destinations.

Credentials

Name and description

The name and description for a credential.

This connector uses the “listrak” credential type, the same credential type as the Listrak Email destination. A credential set up for that destination can be selected here if it has the client ID and secret for the channel this destination sends on. Amperity exchanges the client ID and secret for an access token, and uses only the pair for the destination’s channel.

Email client ID and Email client Secret

Required for the email channel.

A client ID and secret for an email integration that is already set up in Listrak.

SMS client ID and SMS client secret

Required for the SMS channel.

A client ID and secret for an SMS integration that is already set up in Listrak.

Tip

The client ID and client secret are available from the Integrations menu in Listrak. Open the Integrations menu, select Integrations Management, and then from the Integrations page choose an integration. The client ID and client secret are on the Setup tab.

Settings

Name and description

The name and description for a destination.

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.

Channel

Required. The channel this destination sends on: “email” or “sms”. Every Activate node that sends to the destination uses this channel. To send on both channels, add one destination for each.

List ID

Required for the email channel. The ID of the Listrak email list. Amperity sends email messages through this list and reads the list’s profile fields to match personalization attributes. Ignored for the SMS channel.

Sender Code ID

Required for the SMS channel. The ID of the Listrak sender code that SMS messages are sent through. Ignored for the email channel.

Phone list ID

Required for the SMS channel. The ID of the Listrak SMS phone list that SMS messages are sent through. Ignored for the email channel.

Transactional message ID

Required. The ID of the Listrak transactional message to send. Amperity sends it together with the List ID for the email channel, or with the Sender Code ID and Phone list ID for the SMS channel.

Note

When you save the destination, Amperity checks that the settings for the channel are filled in, and then tests the connection by requesting the email list, or the SMS phone list, from Listrak. The test does not check the transactional message ID.

Activate node settings

The rest of the configuration for this connector belongs to the journey that sends to it. Add this destination to an Activate node, then map attributes on the node’s Attributes tab. Two nodes may send to the same destination with different custom attributes. Mapped attributes are set once for the destination in the journey, so every node that sends to it uses the same mapped attributes.

email

Required for the email channel; Amperity does not save the node’s attributes without it. The recipient’s email address, sent as mapped.

phone

Required for the SMS channel; Amperity does not save the node’s attributes without it. The recipient’s phone number. Amperity sends the value as mapped and does not reformat it.

Personalization attributes (email channel)

For the email channel, every other attribute that you map, and every custom attribute on the node, is a candidate profile field value for the message. Before each send, Amperity reads the profile fields of the email list in List ID, and then matches each destination attribute name to a profile field name:

  • Names are matched without regard to case, so “loyalty_tier” matches a profile field named “Loyalty_Tier”.

  • When no profile field matches exactly, an underscore in the attribute name also matches a space, so “first_name” matches a profile field named “First Name”.

  • An attribute that matches no profile field on the list is left out of the request, and the send does not fail.

Amperity sends each matched value as text, with the ID of its profile field. A matched attribute with an empty value for the customer is sent as empty text.

For the SMS channel, Amperity sends only the phone number. Other attributes are not sent.

SMS sends

Amperity does not subscribe a contact to an SMS phone list, and does not check the contact’s subscription before it sends. It sends the phone number, sender code ID, phone list ID, and transactional message ID, and no message content. To subscribe contacts on a schedule, use the Listrak SMS destination.

Failed sends

Amperity makes up to three attempts for each send, with a short delay before each new attempt. Within an attempt, Amperity retries each request up to five times, with increasing waits, after a connection error, a request timeout (408), a rate limit error (429), or a server error (5xx). One request can therefore be made up to 18 times for a send.

Amperity makes another attempt after these failures:

  • 429 Too Many Requests.

  • A server error, 500 or higher.

  • Any other response that is not listed below, and a request that gets no response.

Amperity does not try again after these responses, and the send fails:

  • 400 Bad Request.

  • 401 Unauthorized or 403 Forbidden. Amperity reuses its connection to Listrak for each credential and channel for up to 20 minutes, so after you edit the credential, sends can keep failing for up to 20 minutes. Choosing a different credential for the destination takes effect at once.

  • 404 Not Found.

Amperity sends no idempotency or deduplication key to Listrak. Each request, within an attempt or in a new attempt, is a new request to send the message, and Amperity does not check whether an earlier attempt’s message was sent.

For the email channel, the requests that read the list’s profile fields count toward the same attempt, and fail and retry the same way.

A send that fails all three attempts is not retried later.