Support Documents
Submit a Ticket
Start typing to search…

Listrak Integration V2

Send loyalty program emails through your Listrak account.

Introduction.

As part of your regular marketing communication, you can send marketing emails through Listrak using the loyalty data of customers stored in Zinrelo.
You can send these emails through either Conversation or Journey in Listrak. This article explains how to configure these settings effectively, enabling you to send emails and leverage the associated benefits.

📘

This is the latest version of the Listrak Integration. If you are still using the older version, click here.

Generate your Listrak Client ID and Client Secret

Email Integration

To integrate Zinrelo with Listrak for email marketing, you will need to obtain Client ID and Client Secret IDs from Listrak to put into Zinrelo. Here's how to obtain these:

  1. Navigate to Integrations> Integrations Management > New Integration > Email API in Listrak
  2. You will see two buttons. Information and Setup. Click on Setup.
  3. Give your integration a name, e.g., 'Zinrelo Integration'.
  4. Enable the four Access Levels - List, Contact, Event, Segmentation.
  5. Whitelist the following IP addresses by adding them via the Single IP Address option:
  • 54.243.245.6
  • 184.72.245.194
  1. Save the settings
  2. Click on Setup, and you will see that the Client ID and Client Secret have been populated. Note:_ The client secret is displayed only once. If you lose it, you would need to reset the client secret in the integration.

SMS Integration

To set up SMS integration with Listrak, the setup is similar to the email version. Here's how to obtain the Client ID and Client Secret:

  1. Navigate to Integrations > Integrations Management > New Integration > SMS API in Listrak.
  2. You will see two buttons. Information and Setup. Click on Setup.
  3. Name your integration, e.g., "Zinrelo Integration".
  4. Whitelist the following IP addresses by adding them via the Single IP Address option:
  • 54.243.245.6
  • 184.72.245.194
  1. Save the settings.
  2. Click on Setup, and you will see that the Client ID and Client Secret have been populated. Note:_ The client secret is displayed only once. If you lose it, you would need to reset the client secret in the integration.

Journey Workflow

  1. Navigate to Integrations > Integrations Management > New Integration > Cross Channel API in Listrak
  2. You will see two buttons. Information and Setup. Click on Setup.
  3. Name your integration, e.g., "Zinrelo Integration".
  4. Whitelist the following IP addresses by adding them via the Single IP Address option:
  • 54.243.245.6
  • 184.72.245.194
  1. Save the settings.

Note: The client's secret is displayed only once. If you lose it, you would need to reset the client secret in the integration.


Update the Data in the Platform

To create a Journey or Conversation in Listrak, you must update the client ID and client secret ID in the platform.

Conversation Setup

  1. Log in to your Zinrelo account and navigate to General > Apps > Listrak.
  2. Select Listrak Workflow: “Conversation.” option
  3. Then select Listrak Marketing Mechanism: Email option
  4. For Client ID for Email: Enter the client ID obtained from this step.
  5. For Client Secret For Email: Enter the client secret obtained from this step.

Journey Setup

In the Journey, you can integrate Email, SMS, and Email+SMS.

Email Integration

  1. Select Listrak Workflow: “Journeys.”
  2. Choose Listrak Marketing Mechanism: Email.
  3. For Client ID for Email: Enter the client ID obtained from this step .
  4. For Client Secret For Email: Enter the client secret obtained from this step .
  5. For Client ID for Cross-Channel: Enter the cross-channe client ID obtained from this step .
  6. For Client Secret for Cross-Channel: Enter the cross-channel client secret obtained from this step .

SMS Integration

  1. Select Listrak Workflow: “Journeys.”
  2. Choose Listrak Marketing Mechanism: SMS.
  3. For Client ID for SMS: Enter the client ID obtained from this step .
  4. For Client Secret For SMS: Enter the client secret obtained from this step .
  5. For SMS Short Code ID: Enter the SMS Short Code ID. To obtain this ID, contact the Listrak team.
  6. For Client ID for Cross-Channel: Enter the cross-channel client ID obtained from this step .
  7. For Client Secret for Cross-Channel: Enter the cross-channel client secret obtained from this step .

Email and SMS Integration

  1. Select Listrak Workflow: “Journeys.”
  2. Choose Listrak Marketing Mechanism: Email+SMS.
  3. For Client ID for Email: Enter the client ID obtained from this step .
  4. For Client Secret For Email: Enter the client secret obtained from this step .
  5. For Client ID for SMS: Enter the client ID obtained from this step .
  6. For Client Secret For SMS: Enter the client secret obtained from this step .
  7. For SMS Short Code ID: Enter the SMS Short Code ID. To obtain this ID, contact the Listrak team.
  8. For Client ID for Cross-Channel: Enter the cross-channel client ID obtained from this step .
  9. For Client Secret for Cross-Channel: Enter the cross-channel client secret obtained from this step .

Once you save the details in the platform, you can fetch the list created in Listrak.

To fetch the list and select the webhook, click on “Fetch Lists.”

  • Events to be sent: Select the webhook events you want to listen to. Refer to this document for all webhook events.

  • Existing Email List ID: Select the existing List ID created in Listrak.

  • Custom Field Mapping Email (Optional): How to create these custom attributes and add them to Custom Field Mapping section, click here. If you wish to sync any of these fields, update the null value to the actual value. For example:

  • Existing SMS List ID: Select the existing List ID created in Listrak.

  • Custom Field Mapping- SMS (optional): How to create these custom attributes and add them to Custom Field Mapping section, click here. If you wish to sync any of these fields, update the null value to the actual value. For example:

    Create custom events for journey

For every event, you have to create a custom event in Listrak.

  1. Navigate to Automation>> Journey Hub>> Custom Events.
  1. Click on “New Custom Event.”

  1. Enter the exact “Custom Event Name,” “Property Name,” and “Data Type”. For more information on these event types, please see the tables below for reference.


  2. Click on “Create.”

Types of Custom Event

event_member_enrol

Property NameData TypeDescription
zrl_member_idstringUnique identifier for the loyalty member.

event_points_earned

Property NameData TypeDescription
zrl_txn_activity_idstringActivity ID generating the points.
zrl_txn_activity_namestringName of the activity (e.g., Purchase, Signup).
zrl_txn_award_points_statusstringAward status (e.g., Success, Pending).
zrl_txn_points_awardeddoubleNumber of points awarded.
zrl_txn_points_expiration_datedateExpiration date for the awarded points.

event_points_redeemed

Property NameData TypeDescription
zrl_txn_redeemed_points_statusstringRedemption status (e.g., Success).
zrl_txn_points_redeemeddoubleNumber of points redeemed.
zrl_txn_reward_idstringID of the redeemed reward.
zrl_txn_reward_namestringName of the redeemed reward.
zrl_txn_reward_linkstringReward URL or landing page.
zrl_txn_couponcodestringCoupon code associated with reward.

event_points_deducted

Property NameData TypeDescription
zrl_txn_deduct_points_statusstringStatus of deduction.
zrl_txn_points_deducteddoubleNumber of points deducted.

event_member_tierupgrade

Property NameData TypeDescription
zrl_txn_upgraded_loyalty_tier_namestringName of the upgraded tier.
zrl_txn_upgraded_loyalty_tier_idstringID of the upgraded tier.
zrl_txn_qualified_pointsdoublePoints that qualified for the tier.

event_member_tierdowngrade

Property NameData TypeDescription
zrl_txn_downgraded_loyalty_tier_namestringName of the downgraded tier.
zrl_txn_downgraded_loyalty_tier_idstringID of the downgraded tier.
zrl_txn_qualified_pointsdoublePoints at the time of downgrade.

event_points_expired

Property NameData TypeDescription
zrl_txn_points_expireddateDate when points expired.

event_friend_incentive_request

Property NameData TypeDescription
zrl_txn_friend_incentive_email_addressstringEmail of the friend.
zrl_txn_friend_incentive_couponstringCoupon awarded to friend.
zrl_txn_is_eligible_for_incentivestringEligibility status for incentive.

event_referral_link_share

Property NameData TypeDescription
zrl_txn_referral_link_shared_channelstringSharing channel (e.g., Email, Social).
zrl_txn_referral_link_shared_friend_liststringComma-separated list of friend emails.

event_referral_success

Property NameData TypeDescription
zrl_txn_referral_success_friend_first_namestringFriend’s first name.
zrl_txn_referral_success_friend_last_namestringFriend’s last name.
zrl_txn_referral_success_friend_emailstringFriend’s email address.
zrl_txn_referral_success_coupon_codestringCoupon awarded upon referral.

event_points_rejected

Property NameData TypeDescription
zrl_txn_rejected_points_statusstringStatus of rejection.
zrl_txn_pointsdoubleNumber of points rejected.
zrl_txn_notestringOptional note on rejection.
zrl_txn_detailed_messagestringDetailed reason for rejection.
zrl_txn_activity_namestringName of the activity that was rejected.

event_winback_offer

Property NameData TypeDescription
zrl_txn_offer_valid_tilldateOffer expiration date.
zrl_txn_bonus_pointsintBonus points offered.
zrl_txn_activity_name_to_completestringActivity required to redeem the offer.
zrl_txn_activity_id_to_completestringID of the required activity.

event_available_rewards_reminder

Property NameData TypeDescription
zrl_txn_reward_namestringName of the reward.
zrl_txn_reward_typestringType/category of reward.
zrl_txn_reward_idstringID of the reward.
zrl_txn_reward_valueintValue of the reward.
zrl_txn_points_to_be_redeemedintPoints required for redemption.

event_points_expiration_reminder

Property NameData TypeDescription
zrl_txn_points_to_expiredoubleNumber of points about to expire.
zrl_txn_days_to_expireintDays left until expiration.
zrl_txn_event_points_expiry_datedateDate of upcoming expiration.

event_rewards_within_reach_reminder

Property NameData TypeDescription
zrl_txn_reward_namestringName of the reward.
zrl_txn_reward_typestringType of the reward.
zrl_txn_reward_idstringReward identifier.
zrl_txn_reward_valueintValue of the reward.
zrl_txn_points_to_be_redeemedintRequired points for redemption.

event_campaign_entered

Property NameData TypeDescription
zrl_txn_campaign_entered_event_namestringName of the trigger event.
zrl_txn_campaign_entered_event_idstringEvent ID.
zrl_txn_campaign_entered_delay_in_daysintDelay before entry in campaign (in days).
zrl_txn_entered_campaign_namestringCampaign name.
zrl_txn_entered_campaign_idstringCampaign ID.

event_campaign_exited

Property NameData TypeDescription
zrl_txn_campaign_exited_event_namestringName of the trigger event.
zrl_txn_campaign_exited_event_idstringEvent ID.
zrl_txn_exited_campaign_namestringName of the exited campaign.
zrl_txn_exited_campaign_idstringID of the exited campaign.

Create a List

Before you create a journey in Listrak, you need to create a list. List is where you can configure emails and SMS.

To create a list, navigate to Contacts >> Email Contacts >> List Manager.

Journey Creation

Follow the given steps to create a journey in Listrak:

  1. Navigate to Automation>> Journey Hub>> Journeys.

  1. Click on New Journey >> Start from scratch.
  2. From “Categories” select Custom>> Custom Events.


  1. Define the property by clicking on the Custom Event. From the custom event dropdown, select the event for which you want to create a journey.

  1. Click on the (+) icon and select Email/SMS or both from the element list.

Configure Email

  • Click on Email.

  • Name the step.

  • Select the email list.

  • Click on “Create Message.”

    • Enter the basic details of the sender and receiver.

    • Select the saved email template from the list of templates or create a new one.

  • Compose the email in the email editor.

  • You can save the message for future use.
  • Click on “Create Journey Email message” to use this email in your journey

Configure SMS

  • Click on SMS
  • Name the step.
  • Select the Short Code.
  • Click on Create Message to edit the SMS text.
    • Select the SMS list.
    • Enter the text in the box provided. You can add a property name from the “Add personalization” dropdown.

  • Click on “Create Journey Email message” to use this email in your journey.

Please Note: Define the message delivery time in SMS settings.


Once you are done with journey creation, click on “Activate” to activate the journey.

  1. You can create a Journey or Conversation in Listrak.
  2. Update the Client ID and Client Secret generated in the previous step in the Zinrelo admin console.

Updated 13 days ago