DOCSEARCHbyAlgolia
Submit Docs

Talon.One Developer Documentation

website·Indexed 39 days ago

https://docs.talon.one/

Developer resources for integrating with the Talon.One Rule Engine, featuring the Integration API for real-time session updates and the Management API for programmatic campaign control. Includes SDKs, integration guides for cart item catalogs, and documentation on core entities such as campaigns, customer profiles, rewards, and achievements.

Tokens
165.8K
Snippets
305
Records
1.2K
Agent score
65%

What's inside Talon.One

  2. Overview of Cart Item Catalogs

    Cart item catalogs allow you to synchronize your entire inventory with Talon.One to facilitate the creation of item-based campaigns. Each item in a catalog consists of three built-in attributes:

    • SKU: Mandatory. Each item must have a unique SKU.
    • Product: Optional. Used to group SKUs with similar properties.
    • Price: Optional. The price of the item.

    For rule evaluation, if built-in or custom cart item attributes are missing from the customer session, Talon.One loads them from the cart item catalog connected to the Application.

  3. Overview of Application notifications

    Application notifications inform you of changes occurring within your Application by sending requests to a user-defined URL with a predefined payload. Notifications can be triggered in real time after an event occurs or based on a schedule before an event occurs. Users can configure the request payload size to optimize hardware resource usage by reducing the total number of requests.

  4. Overview of Best Prior Price feature

    Best prior price is a feature that calculates the lowest prior price for an item based on the price history provided to Talon.One. It is primarily used to comply with price transparency regulations, such as Article 6a of the EU's Omnibus Directive, which requires retailers to display the lowest price of an item from a preceding period (typically 30 days or more) alongside any advertised sale price. This feature is used in conjunction with strikethrough pricing campaigns.

  5. Overview of Loyalty notifications

    Loyalty notifications allow you to track the status of loyalty points and tiers in your loyalty program. They function similarly to webhooks, sending requests to a specified URL with a predefined payload. Notifications can be triggered in real-time (immediately after a qualifying event) or based on a schedule. You can configure the request payload size to optimize hardware resources by grouping events.

  6. Overview of Talon.One Management API keys

    Management API keys are used for backoffice operations, such as importing coupons or retrieving campaign data. They are recommended for authentication over the bearer token scheme. Access can be restricted by selecting specific allowed endpoints and limiting the key to specific Applications to increase security.

  7. Overview of Custom Effects in Talon.One

    Custom effects allow you to define a custom data structure to be sent from Talon.One to your own platform when a rule is triggered. They can be used as regular effects or failure effects in rules and are returned via the Integration API.

    Custom Effect vs. Webhook:

    • Use a Custom Effect if you prefer receiving the data in your integration layer and parsing it alongside other effects.
    • Use a Webhook if you want the data sent directly to a specific URI.

  9. Overview of Loyalty Subledgers

    A loyalty subledger is an individual loyalty points wallet within a loyalty program. Subledgers allow a business to maintain multiple separate point balances for a single customer concurrently without needing to create separate loyalty programs. This is particularly useful for multi-store environments where points earned at a specific store should only be redeemable at that same store.

  10. Overview of Value Maps

    A Value Map is a two-column list containing SKUs (identifiers) and associated numeric values. Once created, it automatically generates a cart item filter named Value_map_items. This allows you to reference specific values mapped to SKUs using the Mapped Value attribute within per-item effects or cart item filters.

  11. Overview of the Talon.One Integration Hub

    The Integration Hub provides pre-built integrations for specific use cases (e.g., issuing a coupon when a customer reaches a new loyalty tier) that can be set up without writing code. To access the Integration Hub, navigate to Account > Integrations > Generic integrations.

  12. Overview of Talon.One Shopify integration features

    The Talon.One Shopify app enables real-time, bidirectional data synchronization between Shopify and Talon.One. Key capabilities include:

    • Syncing product data and customer profiles for personalization and loyalty programs.
    • Sending customer session data (including shopping carts) to Talon.One.
    • Retrieving customer data (e.g., loyalty points) from Talon.One.
    • Receiving strikethrough pricing updates from Talon.One.
    • Applying discount effects from Talon.One to the Shopify shopping cart at checkout.