Introduction

Metadata, as the term suggests, refers to a collection of data that offers supplementary descriptive information or attributes about a specific piece of data or resource.

Within the context of Zinrelo, metadata serves a similar function by providing additional information about activities and rewards. It is a step towards providing customized experiences through activities and rewards. To program the custom experiences, one needs to know which activities or rewards those experiences should apply to. There are use cases where the determining factor is something other than the system defined fields available for activities and rewards. This is where metadata values can be used.

Let’s understand it better with an example:

Consider a product reward that needs to capture the shipping address of the redeemer in the course of redemption. We can write some custom code to show a redemption form when the user selects a reward. But how can we decide which rewards should have a form? We may not want to show the shipping address form on all rewards. This is where metadata can be useful. We can define a metadata property such as ‘Shipping form required’ and for rewards that require it, the value can be "Yes". Using this metadata field, our custom code can show the form on the appropriate rewards.

Where can I find metadata?

You can find it in the configuration settings of all activities and rewards.

How can I create metadata?

To create metadata, follow these steps:

1. Navigate to the activity you wish to configure.
2. Click on the "Metadata" tab and select "Add Metadata."

3. Enter the desired "Metadata Name" and assign a value in the "Metadata Value" field.

4. Click the "tick" button to save the metadata.

To delete saved metadata, use the delete icon. To add more metadata, click on the "Add Metadata" button.

Important considerations:

• "Metadata name" is limited to 100 characters, while "Metadata Value" can contain up to 1000 characters.
• Metadata information will be included in all API responses related to rewards and activities. You can also find metadata information in webhook logs. This is detailed below.
• Each reward can have 20 unique keys, and there is a limit of 100 unique keys for all rewards.
• Each activity can have 20 unique keys, and there is a limit of 100 unique keys for all activities.

Where will the activities and rewards metadata show up?

Metadata values will be available in all API responses and webhooks where we return activities and rewards. These values can be used in programming the logic of loyalty programs.

APIs

• List All Activities
• List all the Eligible Activities for a Member using Member ID
• List all the Eligible Activities for a Member using Zinrelo Generated Member ID
• Retrieve an Activity using Activity ID
• Retrieve an Activity using Zinrelo Generated ID
• List All Rewards
• Get Eligible Rewards with Member ID
• Get Eligible Rewards with Zinrelo Generated Member

Webhooks

• Rewards within reach Reminder Event
• Winback Offer Event
• Available Rewards Reminder Event

Use Cases

Fab Apparels, an online shopping app, aims to effectively categorize their rewards as “trending” and “limited time offer” to enhance the user experience.

Solution
During the reward configuration process, Fab Apparels can create a metadata field called "Category." This metadata field will have two specific values: "Trending" and "Limited Time Offer."

Fab Apparels can utilize the assigned "Category" metadata values in their code to control the display of rewards within the app. By programming the app to recognize and filter rewards based on their metadata values, Fab Apparels can ensure that rewards labeled as "Trending" show up in a dedicated section labeled as such, while rewards categorized as "Limited Time Offer" are displayed in a separate section with the appropriate label.

Fitness Club, an online store specializing in workout equipment, offers experiential rewards fulfilled by a 3rd party vendor by the name ‘Tremendous’. To facilitate processing of rewards, Tremendous requires the rewards to be identified by a specific ID within their system. Fitness Club requires a solution that automatically notifies Tremendous when a member redeems a reward along with the Tremendous ID of that reward.

Solution:

Within the Zinrelo system, Fitness Club can create a Metadata field named "Tremendous ID." Whenever a new reward is configured, the program admin will enter the ‘Tremendous ID’ in the metadata field. This information allows Fitness Club to map the reward to the Tremendous ID for that reward’.

Tremendous will monitor the redemption events in the program. Whenever a reward is redeemed, the system will fetch the metadata properties of the redeemed reward. The metadata will contain the ID that Tremendous can use for further processing.