Add New External Reward

To create a new external reward, follow these steps:

1. Navigate to the External Rewards Section

• Go to the External Rewards dashboard.
• Click on the Add New External Reward button.

Open image-20250317-085920.png

General Information

Let's set up the basic details for the external reward. This section defines the essential attributes of the reward, ensuring proper identification and management.

Open image-20250317-090046.png

Benefit Type

• External – Indicates that this reward is sourced from an external partner or vendor rather than an internal system.

Reward ID *

• A unique identifier assigned to the reward for tracking and reference purposes.
• This ID helps distinguish it from other rewards in the system.

Reward Name *

• A descriptive name for the reward that users can easily recognize.
• Should be clear and concise to convey the benefit offered.

Reward Status & Limited Availability

Reward Status – Live

• A Live reward status means the reward is available for members to earn. Administrators can choose to publish it right away without scheduling a future date.
• If the Limited Availability flag is off, the reward remains evergreen, meaning it will always be available for members.
• If the Limited Availability flag is on, the reward can only be earned within a specific timeframe:
• Start Date – When the reward becomes available.
• End Date – When the reward is no longer earnable.

Reward Status – Scheduled

• A Scheduled reward is set to become Live on a future date. This is useful for time-sensitive campaigns where a reward should be available only after a certain point.
• If Limited Availability is enabled, the reward will only be available during the defined period.
• On the Start Date, the reward automatically transitions from Scheduled to Live without requiring manual intervention.

Reward Status – Draft

• A Draft reward is still in the setup phase and is not yet available for members to earn.
• It is useful when administrators are still configuring the reward and are not ready to publish it.

Reward Status – Archived

• An Archived reward is no longer available for members to earn, but it remains in the system for reference.
• If a Live reward has Limited Availability, it will automatically move to Archived status once the End Date is reached.
• Members who earned the reward before it was archived will still retain it.
• Administrators cannot reactivate an Archived reward but can create a new version if needed.

Limited Availability

Defines whether a reward is available for a restricted time frame, working in conjunction with the Reward Status to determine when and how members can earn it.

Availability Period – Specifies the timeframe within which the reward can be earned, based on the reward’s status:

• Start Date – The date when the reward transitions to Live status, making it available to members.
• End Date – When the reward is no longer earnable.

This section ensures that the reward is set up with accurate details, making it easier to manage and track its availability and usage.

Reward Attribute & Image URL

In this section, you can define the reward’s key attributes and provide an image URL to visually represent the reward.

Open image-20250317-090338.png

Reward Attributes

Overview

Reward attributes function as extended key attributes, ensuring consistency with the core reward data structure. These attributes define the essential details of a reward, such as its value, expiration date, eligibility criteria, and any custom parameters needed for different loyalty programs. By maintaining a structured approach, reward attributes help streamline reward issuance, redemption, and tracking.

Additionally, within the Additional Loyalty Settings, administrators can create and customize new reward extended attributes to align with evolving program requirements. This flexibility allows businesses to introduce new reward types, set conditional eligibility rules, or modify existing reward structures without disrupting the overall loyalty ecosystem.

The ability to extend reward attributes ensures scalability, making it easier to adapt to future promotional strategies, regional preferences, and customer engagement initiatives.

For example:

Market

• Specifies the region or country where the reward is available.
• Helps in filtering rewards based on user location and regulatory requirements.

VAT (Value-Added Tax)

• Indicates whether VAT is applicable to the reward.
• The value entered may represent the tax percentage or a tax code, depending on the system setup.

Reward Image URL

Overview

A direct URL to an image representing the reward enables users to quickly recognize and differentiate it within the catalog. A visually appealing and high-quality image enhances user engagement, making the reward more attractive and increasing the likelihood of redemption. It is important to ensure that the image is clear, well-lit, and appropriately sized to maintain visual consistency across different devices and platforms. Additionally, the image should be hosted on a reliable server to prevent loading issues and ensure accessibility for all users. Proper hosting also helps maintain fast load times, improving the overall user experience in the loyalty program.

Add Image URLs

You can add upto 5 image URLs to visually represent the reward. These images may be used across different platforms where the reward is displayed.

How to Add Image URLs:

• Enter a valid image URL in the designated fields.
• Ensure the URLs point to publicly accessible images (e.g., hosted on a CDN or an image storage platform).
• The images should be high-resolution and properly formatted (JPEG, PNG, or JPG recommended).

Image URL Fields

Open image-20250317-090521.png

• Enter URL (Primary image)
• Enter URL (Alternative views or promotional images)

By adding these attributes and an image, you provide a clearer representation of the reward, making it more attractive and structured for users.

Redemption Data

When awarding an external reward to a member, it may be necessary to collect additional information from them, referred to as redemption data. This data helps ensure that the reward can be properly issued and utilized.

For example, if the external reward includes free shipping, it might be essential to verify the member’s shipping address before fulfillment. In such cases, the system can prompt the member to provide their address or other location-based details necessary for reward processing.

The required redemption data can be predefined based on the reward type and integrated into the system via APIs. Once collected, this data will be reflected in the respective API responses, allowing you to retrieve and utilize it efficiently. This ensures a seamless redemption process and enhances the overall user experience.

Open image-20250402-051039.pngRedemption Data Fields:

Enter Name

• The name of the redemption attribute that will be stored.
• This could refer to a specific redemption-related field, such as a transaction ID, user ID, address or external reference.

Supported Data Types:

• VARCHAR – Stores text-based values such as redemption codes, user details, or reference IDs.

{to be removed after future updates}

• INT – Stores whole numbers, such as transaction counts or user IDs.
• DECIMAL – Stores numeric values with decimal points, useful for monetary values like reward amounts.
• DATE – Stores date values (YYYY-MM-DD), useful for tracking redemption dates.
• DATETIME – Stores date and time values (YYYY-MM-DD HH:MM:SS), ideal for recording the exact timestamp of redemption events.

Remove Option

• If a redemption attribute is no longer needed, you can remove it by clicking the Remove button.
• Ensure that you only remove attributes that are not actively used in redemption processes.

This section ensures that all necessary data points for tracking and validating redemptions are properly configured.

Click on Create New Reward to finalize and generate the external reward based on the specified requirements.

External Rewards Report

The External Rewards Report provides a summary of rewards issued to members through external systems or integrations. This report helps track the distribution, status, and source of external rewards, ensuring transparency and effective reward management.

Key Insights:

• Tracks reward issued over a specified period.
• Provides details such as Claimed Date (Issued Date), Reward ID, Reward Name, Status, Reason, and Source.
• Helps analyze reward allocation and member engagement with external incentives.
• Identifies whether rewards were issued via Manual Assignment or via Journey.

This report is valuable for administrators and program managers to monitor reward fulfillment, optimize reward strategies, and enhance the overall member experience.

Open image-20250403-064356.png

• Claimed Date: The date when the reward was issued to the member. This timestamp helps track when the external reward was granted.
• Name: The display name associated with the user. This name is typically used for recognition and reference in reports but may not always be unique.
• User ID: A unique identifier assigned to a user within the system. This ID is used to track and reference the user across various transactions, ensuring accurate record-keeping for external rewards.
• Reward ID: A unique identifier assigned to the reward. This helps distinguish between different rewards in the system.
• Reward Name: The name of the reward issued to the member. This provides a human-readable description of the reward.

Open image-20250403-063538.png

• Status: Indicates whether the reward has been Awarded to the member. This confirms that the reward has been successfully granted.
• Reason: The justification for why the reward was awarded, such as successful completion of an action, campaign eligibility, or manual issuance by an admin.
• Source: Specifies how the reward was issued—either Manual Assignment (directly granted by an admin) or through Journey (automatically issued as part of a defined reward flow).