Create Touchpoints & Activities for Activity API


Touchpoints serve as the connections between LoyaltyOS and other systems. These Touchpoints facilitate the retrieval of data from LoyaltyOS.

Both Static APIs and Dynamic APIs require the establishment of Touchpoints. Authentication for APIs is tied to their corresponding Touchpoints.

In the LoyaltyOS Admin Portal, administrators have the authority to create, view, edit, and delete Touchpoints.


Activities refer to the recorded actions at Touchpoints, allowing data transfer between LoyaltyOS and integrated systems. These actions can include making payments at a POS, sending SMS messages, reading articles, and more.

Activity API is categorized as a Static API, yet its parameters remain dynamic. In the LoyaltyOS Admin Portal, administrators have the authority to create, view, edit, and delete Activities, which consequently define the parameters of Activity API.

Each Activity is mapped to one and only one Touchpoint, while each Touchpoint can be mapped to one or more Activities.

If an Activity is generated without being assigned to any Touchpoint, the Access Key in the Payload section will not be accessible. Additionally, any changes made to an Activity within one Touchpoint will automatically apply to the same Activity in all other Touchpoints.

Step 1: Go to Business Integration Builder

Step 1.1: Go to Operator Config.

Step 1.2: In Operator Config, go to System Integration.

Step 1.3: In System Integration, go to Business Integration Builder.

Step 2: Create Touchpoints

Step 2.1: Click the Create button located in the top left corner of the Business Integration Builder screen to create a new Touchpoint.

Step 2.2: In the Create Touchpoint pop-up, enter a Name and select a Channel and Integration Method from the drop-down lists. Currently, LoyaltyOS supports APIs as the primary integration method.

Step 2.3: Select OAuth 2 as the Authentication Protocol.

Step 2.4: Click the Save button.

Step 3: Create Activities

Step 3.1: Click the Add new button located in the top right corner of the Activity block to create a new Activity.

Step 3.2: In the Create Touchpoint pop-up, enter Activity Name.

Step 3.3: Select Input from the drop-down list, which is either Single API or Batch API.

Step 3.4: Select Type from the drop-down list, which is either Common or Use Loyalty Currency. Common means the Activity is unrelated to the Loyalty Currency defined in LoyaltyOS.

Step 3.5: Select Applied Attribute Type from the drop-down list which can be Influence, Behavior, or Purchase.

Step 3.6: In the Available Attributes section, select Domain from the drop-down list based on the business requirements. If no specific domain requirement exists, choose Cross Domain, which includes the default necessary information for the Activity.

Step 3.7: Drag items from the Available Attributes section and drop them into Applied Attributes. section. If you cannot find the approciate attribute, you will need to add a new attribute in the Data Design setup first.

Step 3.8: Review and customize Applied Attributes.

Step 3.9: Click the Save button.

Step 4: Get Access Token

Step 4.1: Select desired Touchpoint in the Identify Touchpoints section.

Step 4.2: Select desired Activity in the Identify Activities section.

Step 4.3: Click the edit icon in the Actions column.

Step 4.4: In the Activity Detail pop-up, scroll down and click the Payload section which is located at the end of the pop-up.

Step 4.5: In the Payload secton, click the Access Token tab to see the Sample Request and Sample Response.

Step 5: Get Activity Payload

After viewing the Access Token, click the Activity Payload to see the Sample Request và Sample Response. These parameters are used for establishing the integration.

Last updated