Skip to main content

Receiving the Loyalty Ledger of a Customer through Iterable

This is a guide to integrating Iterable with Talon.One. This guide will walk you through setting up and using the Talon.One endpoint that Iterable uses to receive Loyalty Ledger information for a particular user.

After setup, Iterable will be able to automatically request user-specific loyalty ledger information directly from Talon.One. For example, you could send an email that dynamically populates the number of loyalty points each customer has accrued.

Generating an API key for a 3rd party service#

Let's generate a Talon.One API key that we will use for a 3rd-party service, in our case, Iterable.

  1. Navigate to the developer settings of your Talon.One Application.
  2. Click Create API Key
  3. For Do you want to use this API Key with a 3rd party service?, select Yes.
  4. Select Iterable from the dropdown.
  5. Select and expiry date and click Create API Key.
  6. Copy it for later use.

Using the endpoint#

We will create a data feed in Iterable in the next section. The data feed relies on the Get loyalty points endpoint endpoint:

https://[deployment].talon.one/v1/loyalty_programs/[loyaltyProgramID]/profile/[userID]

Where:

  • deployment*: Your Talon.One deployment base URL. For example, if your deployment URL is demo123.talon.one, use demo123.
  • loyaltyProgramID*: The ID of the loyalty program you want to use.
  • userID*: The ID of the user whose loyalty ledger balance you'd like to check. This must match the userID you send to Talon.One.
Example
curl --location --request GET 'https://demo.talon.one/v1/loyalty_programs/123/profile/DemoUser \--header 'Authorization: ApiKey-v1 [YOUR_API_KEY]'

See the response in the API docs.

Configuring Iterable#

In Iterable, create a new data feed to pull in loyalty information:

  1. Choose a name, for example Talon.One loyalty.
  2. Using the URI generated in the previous section in the URL field and set Format to JSON.
  3. In HTTP Headers, type APIKey-v1 and enter your the API generated earlier.

Creating a template and linking the data feed#

  1. Create an Iterable template that will be used for your marketing campaign

  2. In the Advanced Options tab, select your Talon.One data feed.

    For more information about data feeds, see the Iterable docs.

  3. Reference the loyalty information and/or entire response from Talon.One within the email template by using square brackets based on the endpoint response.

    For example: [[result]], [[result.value]].

    See the Iterable Docs.

  4. Check the template and placement of the data feed response by using the Preview with data tool.

  5. Click Load template feed in order to bring in the data feed response data into the template.

Related links#