Skip to main content

Fetch achievement data from Talon.One using Adobe

In this tutorial, let's set up Adobe Experience Platform to fetch achievement data from Talon.One using the Talon.One Batch Source Connector.

After that, you can use Adobe Journey Optimizer, for example, to send a reward code to every customer who completed a specific achievement in the last week.

How it works

If a customer has completed an achievement in a session, this is recorded as an effect in a talon_session_closed event in Talon.One.

The batch source connector pulls these events from Talon.One, filtered by event type. Adobe Journey Optimizer can then act on that data to send targeted messages.

This approach is well suited for handling high-volume batched event data. For use cases where you need to react immediately as events occur, use the streaming events source.

For more information, see our overview page and the documentation provided by Adobe.

Talon.One requirements

Set up the integration

1

Create an API key in Talon.One

In the Campaign Manager, create a Management API key.

We will use the API key in a later step to configure the batch source connector.

2

(Optional) Create an achievements schema in Adobe

If you already have a schema in Adobe Experience Platform that includes the necessary fields to capture achievement data, you can skip this step.

For this tutorial, let's assume we don't have a suitable schema yet. As a starting point, we can use the Loyalty Challenge State field group provided by Adobe.

  1. In Adobe Experience Platform, open the Schemas workspace.
  2. At the top right of the page, click Create schema.
  3. Choose Manual and click Select.
  4. Choose Experience Event as the schema base class and click Next.
  5. In Name and review, provide a name for the schema, for example, Talon.One Achievements Schema, and click Finish.
    The schema editor opens.
  6. In the left sidebar, under Composition, next to Field groups, click Add.
  7. In the list of field groups, find Loyalty Challenge State, select it, and click Add field groups.
    The schema should now include an _experience.ajo.loyalty.challenge object.
  8. In the right sidebar, under Schema properties, enable Profile, confirm the dialog regarding the primary identity, and click Enable.
  9. Click Save.
3

Create the achievement in Talon.One

Let's create the achievement and complete it, so that we have some data to work with when configuring the batch connector:

  1. In your campaign, create an achievement with the following properties:

    • Type: Recurring on completion
    • Name: Stamp Collector
    • API name: stamp_collector
    • Description: You earned a stamp with every purchase and filled your card. Reward unlocked.
    • Target: 5
  2. Create a rule with the following properties:

    WhatNameProperties
    ConditionsCheck for event types
    and custom event values
    Event type: Customer Session Closing
    EffectsUpdate customer progress
    • Achievement name: Select the achievement you created.
    • Update progress by: 1

    Now, whenever a customer session closes, the achievement progress is increased by 1. When the customer reaches the target of 5, the achievement is marked as completed.

  3. Send five API calls to the Update customer session endpoint, each with a different customerSessionId and with the state property set to closed.

The last API call should trigger the completion of the achievement for the corresponding customer session, and create an effect of type increaseAchievementProgress with the isJustCompleted property set to true.

4

Configure the batch source connector in Adobe

  1. Download the example achievement mapping file.
  2. In Adobe Experience Platform, open the Sources workspace.
  3. On the Catalog page, in the Loyalty section, find the Talon.One Batch Source Connector. If available, use the (Beta) version to access the latest features and improvements.
  4. Click Set up or, if you used the connector before, Add data.
  5. Select New account and provide the following authentication details:
    • Account name: Type a descriptive name, for example, Talon.One Batch Account.
    • baseUrl: Type the base URL of your Talon.One deployment, for example, mycompany.europe-west1.talon.one.
    • Talon.One Management API key: Type ManagementKey-v1 , followed by the API key you created in the previous step. For example, ManagementKey-v1 abcdef1234567890.
  6. Click Connect to source, then click Next.
  7. In Select data, provide the following details:
    • applicationId: The ID of your Talon.One Application.
      tip

      To see the Application ID, open your Talon.One application and check the URL in your browser.
      For example, if the URL is https://mycompany.europe-west1.talon.one/applications/198/, the application ID is 198.

    • sessionType: The event type. In this tutorial, we want to track completed achievements in closed sessions, so we use talon_session_closed.
  8. Click Select, verify that data has been fetched, and click Next.
    important

    Without data, you will not be able to complete the next steps.

  9. In Dataset details, create a new dataset based on the schema you created and name it, for example, Talon.One Achievements Dataset.
  10. Enable the Profile dataset option.
  11. In Dataflow details, provide a name for the dataflow, for example, Talon.One Achievements Dataflow, and click Next.
  12. In Mapping, click Clear all.
  13. Click Import mapping > Import mapping from file, upload the example mapping file from step 1, and click Next.
  14. In Scheduling, choose how often you want the dataflow to run. To run it once a week, select Week and set the interval to 1.
  15. Click Next and review the dataflow details. If everything looks good, click Finish.

The batch source connector now runs immediately and again next week, pulling any new achievement data from Talon.One into Adobe Experience Platform.

5

Preview the data

Let's check if the achievement data has arrived in Adobe Experience Platform:

  1. In Adobe Experience Platform, open the Datasets workspace and open the dataset you created for this tutorial, for example, Talon.One Achievements Dataset.
  2. In the top right of the page, click Preview dataset to check for new data.
    If the button is disabled and labeled Preview not available, wait and check again. It can take several minutes for the data to be received from Talon.One and appear in the dataset.
6

Next steps

Now that you have achievement data in Adobe Experience Platform, you can use it to trigger personalized customer journeys in Adobe Journey Optimizer.

For example, you can set up a journey that sends a congratulatory email with a unique reward code to customers who completed a specific achievement in the last week.