Introduction
Talon.One provides personalized incentives for your mobile marketing CRM and allows you to launch contextual 1-to-1 coupon, referral, discount, and loyalty campaigns quickly and efficiently.
MoEngage <> Talon.One
The MoEngage and Talon.One integration can help take your loyalty or coupon program to the next level by sending codes generated by Talon.One to your audience through MoEngage campaigns.
The following Talon.One functionalities are supported:
Integration
| library_add_check |
Prerequisites
|
Step 1: Generate authentication key on Talon.one
- Open your Talon.One Application in the Campaign Manager and click Settings > Developer settings.
- Click Create API Key
- Select Yes for Do you want to use this API Key with a 3rd party service?
- Select Customer Engagement from the dropdown.
- Select and expiry date and click Create API Key.
- Copy it for later use. Use the key in the
Authorizationheader of each of these endpoints:Example:
Authorization: ApiKey-v1 dbc644d33aa74d582bd9479c59e16f970fe13bf3
Step 2: Define Talon.one content API on MoEngage
| info |
Information We've revamped our dashboard settings UI. Content API is now available in Settings -> Advanced Settings -> Content API in the revamped UI. For more information, refer to Summary of Changes - Settings UI Revamp. |
Use MoEngage content APIs to add Talon.One as one of your endpoints.
On your MoEngage dashboard -
1.
Navigate to Settings -> Advanced Settings -> Content API. Click + Add content API at the top right corner of the Content API screen.
Navigate to Settings >> APIs >> Content API. Click Add.
2. Add your Talon.One subdomain to the endpoint URL.
2.a) Create coupon
Headers
| Parameter | Description | Example |
|---|---|---|
Authorization*
|
Required. API authorization key | ApiKey-v1 <TOKEN> |
customer-engagement-platform-name*
|
Required. Enter MoEngage here | <MoEngage> |
destination-hostname*
|
Required. The base URL of your Talon.One deployment. | https://mycompany.europe-west1.talon.one/ |
X-DRY-RUN |
Indicates whether to persist the changes. Changes are ignored when dry=true
|
true |
Path parameters
| Parameter | Description | Example |
|---|---|---|
campaignId*
|
Required. The ID of the campaign in Talon.One where the coupon will be created. | 34 |
applicationId*
|
Required. The ID of the Application in Talon.One. | 12 |
externalCampaignId*
|
Required. The external campaign id that should be referenced | abc123 |
recipientIntegrationID |
The integration ID of the only customer that can use the generated coupon code. Leave blank to allow any user to use the coupon. | abc123 |
discountLimit |
The discount amount the coupon is worth. Can be blank if for example the coupon provides a 10% discount or something other than a set value of discounts. | 1.23 |
startDate |
Time when the coupon starts becomes valid. | 2020-12-31T13:00:00Z |
expiryDate |
Time when the coupon stops being valid. | 2021-12-31T13:00:00Z |
Attributes |
Object containing all the coupon attributes to set on the coupon. |
To set a custom attribute, add the attribute name and value as an extra query parameter prefixed with a .. For example, if you have an email attribute, set it with: &.email=john.doe@example.com.
2.b) Create referral
URL
https://integration.talon.one/customer_engagement/referralHeaders
| Parameter | Description | Example |
|---|---|---|
Authorization*
|
Required. API authorization key | ApiKey-v1 <TOKEN> |
customer-engagement-platform-name*
|
Required. Enter MoEngage here | <MoEngage> |
destination-hostname*
|
Required. The base URL of your Talon.One deployment. | https://mycompany.europe-west1.talon.one/ |
X-DRY-RUN |
Indicates whether to persist the changes. Changes are ignored when dry=true
|
true |
Path parameters
| Parameter | Description | Example |
|---|---|---|
campaignId |
Required. The ID of the campaign in Talon.One where the referral code will be created. | 34 |
externalCampaignId |
Required. The external campaign id that should be referenced | abc123 |
advocateprofileintegrationid |
Required. The integration ID of the advocate | abc123 |
friendprofileintegrationid |
The profile ID of the referred customer. | abc123 |
usagelimit |
Number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | 1.23 |
startDate |
Date when the referral code can be used. | 2020-12-31T13:00:00Z |
expiryDate |
Date when the referral code can't be used anymore. | 2020-12-31T13:00:00Z |
Attributes |
Object containing all the coupon attributes to set on the coupon. |
2.c) Fetch loyalty ledger
URL
GET loyalty
https://integration.talon.one/customer_engagement/loyaltyHeaders
| Parameter | Description | Example |
|---|---|---|
Authorization |
Required. API authorization key. | ApiKey-v1 TOKEN |
customer-engagement-platform-name |
Required. Enter MoEngage here | <MoEngage> |
destination-hostname |
Required. The base URL of your Talon.One deployment.. | https://mycompany.europe-west1.talon.one/ |
Path parameters
| Parameter | Description | Example |
|---|---|---|
profileIntegrationID |
Required. The integration ID of the customer profile in Talon.One. | abc123 |
loyaltyProgramID |
Required. The ID of the loyalty program in Talon.One. | 34 |
projectionEndDate |
Required. The end date to query the projected loyalty balances. You can project results up to 31 days from today. | 2020-12-31T13:00:00Z |
3. Click Save. And you will see your Talon.One API added in MoEngage
Step 3: Using Talon.One's content in MoEngage campaigns
You can now use these content APIs in your campaigns. Read here to know more.
-
-
- On step 2 of your campaign creation, enter @.
- In the pop-up, select the Content API configured in Step 2.
- You can use MoEngage templating language to parse through the API response and use the content in your campaigns. Read about the Talon.One API responses in the following links: Create coupon , Create referral , Fetch loyalty ledger
-