My Extole LoginProduct DocsTechnical DocsAPI Reference

SessionM

This guide will walk you through the technical steps for setting up a successful Extole referral program that integrates with your loyalty program powered by SessionM.

Suggest Edits

Before You Start

Synchronize Extole and SessionM User Profiles

When advocates and referred friends earn rewards within your referral program, Extole will promptly notify SessionM to deliver points or an offer to their loyalty accounts. To establish this connection, you’ll need to have an up-to-date list of all loyalty program users within the Extole platform. This can be facilitated by your Extole and SessionM delivery teams.

Upload Existing Loyalty Users in Extole

Work with your SessionM delivery team to pull a one-time file of all existing users. You can then upload the CSV file in Extole's Batch Jobs center with the data fields: sessionm_id, external_id, and email.

Send New Loyalty Users to Extole

In the Extole Security Center, generate an Extole Access Token and provide it to your SessionM delivery team. Your SessionM delivery team can then configure a webhook that notifies Extole's Events API every time a new user signs up for your loyalty program. The webhook should contain the users sessionm_id, external_id, and email.

Update Your DNS & SPF Records

Complete a DNS update to ensure all links in your referral program are in your domain: share.yourcompany.com/jsmith. Additionally, if you are planning on sending emails from the Extole platform, you'll need to update your SPF Records as well. Refer to Extole DNS Requirements for additional information.

Technical Setup

Step 1: Deliver Calls-To-Action using Extole's SDKs

Marketing your Extole programs involves a combination of onsite and in-app placements that can be implemented on your front-end using Extole's Javascript and Mobile SDKs. These SDKs allow you to display CTA’s like “Refer and Get $20” and also enable referral tracking and attribution.

Javascript SDK for Website Marketing

For instructions on how to add the Javascript SDK to your website, consult with your Extole team or refer to Extole's Javascript SDK. All Extole marketing tags must include a parameter for the users' email to ensure this information is being passed into Extole user profiles.

Mobile SDKs for In-App Marketing

For instructions on how to add Extole’s Mobile App SDK to your app, consult with your Extole team or refer to Extole's Mobile SDKs.

In-app marketing placements

Marketing placement examples

Step 2: Configure Your Event Data

Events are actions that your customers take throughout the customer journey. Extole uses events to trigger actions, such as attributing referrals, sending emails, and triggering rewards.

Send Online Events via SDK

Use the event tags in Extole's Javascript SDK and Events tracking in Extole’s Mobile SDKs to send Extole a loyalty_signed_up event every time a user signs up for your loyalty program on your website or mobile app. You can also send online purchase events using this method.

Event Tag NameProperties
loyalty_signed_upemail (required)
purchasedemail (required)
partner_conversion_id(required) — a unique ID for the order, such as an order ID
cart_value— to apply Extole reward rules and provide revenue reporting
coupon_code — for reporting and attribution

Send Offline Events via SFTP or API

Offline events, such as in-store purchases, can be sent to Extole from any system via SFTP or using Extole's Events API. You can also use the same SFTP or API connection to send online purchase events if desired.

Step 3: Connect Extole and SessionM to Reward Customers

You can choose to reward your program participants with SessionM points or offers or with coupon codes.

Reward with SessionM Points or Offers

To reward customers with points or offers, follow these steps:

  1. Set up Promotional Campaign in SessionM
    • Work with your SessionM delivery team to set up a promotional campaign with an offer or points outcome in SessionM. You can also configure a messaging campaign for any earned reward communications.
  2. Set Up The Extole and SessionM integration within your Extole account
    • Navigate to the Partners page within the Extole platform. Select the SessionM integration.
    • Install the SessionM integration by clicking the install button and providing the API Key, API URL (provided by your SessionM delivery team), and Erasure Client Key ID (provided by your Extole team.)
      • SessionM Events API Key: This key acts as a secure authentication token granted by SessionM to authorize requests from Extole to SessionM's Events API.
      • SessionM Events API URL: The URL endpoint where SessionM's Events API is hosted. This allows Extole to communicate with SessionM's platform.This will be provided by SessionM.
      • Extole Erasure Client Key ID: An identifier used to securely process customer data erasure requests from SessionM. For assistance in generating this key, please reach out to your Extole team.
    • Upon successful installation, a SessionM Reward Supplier is created and can be added to any Extole campaign. Your Extole team can assist with adding the Reward Supplier to the appropriate campaigns and testing the integration.

Reward with Single Use Coupon Codes

If you would like to reward program participants with coupon codes, you can create them in your SessionM account or any other couponing system. Once you have generated the codes, you can simply upload them directly to the Rewards Center in the Extole platform.

Updated 16 days ago