Set up External point distribution (API)

In this guide, we’ll walk you through how to set up a customer club with the External point distribution (API) earning type in Customer Loyalty Center.

This setup is used when your customers’ points are handled in an external system and you want to send these points/discounts to Heyloyalty. Point write-offs are also sent to Heyloyalty. This way, you can use points data in your emails, segmentation and automated flows.

This guide will help you create the integration and configure the necessary settings.

Step 1: Create the integration

Go to Integrations → List integrations. Find Customer Loyalty Center and click Setup integration.

Note: If you cannot create the integration, it is because your account does not have a Premium license.

Then click Create Customer Loyalty Center.

The first time you set up the integration, you need to accept the terms and conditions via a one-time code sent to your email.

Step 2: Configure the integration

Once the integration is created, you need to fill in the following:

• List: Select the list you want to associate the integration with. Only contacts in this list will be assigned points.

Note: If you can’t find your list, it’s because a tracking integration has not been set up. Learn how to set it up here.

• Earning type: Select External point distribution (API).
• Earning period: You can choose between two types:
  • Fixed period: The period is set with specific start and end dates for both earning and using points. The system automatically updates the year when the period expires. Read more about the setting here.
  • Dynamic period: The period is calculated individually for each customer based on their activity. Read more about the setting here.
• Enable point depreciation: Here you can choose from the options below:
  • No: Points can ONLY be written off if the customer uses our “removePoints” function via the API’s removePoints endpoint.
  • Yes: Points can be written off if they are included in the tracking script or sent via the CreateOrder endpoint.

A newer setting called Overflow handling has also been added.
Select Block assignment while in overflow if you do not want to assign points to the member when they have used more points than they have available.
Select Clear overflow before assigning points if new points should be used to offset the overflow, so that only the remainder becomes available points.

Edit your setup

You can always change your integration by clicking the three dots next to the integration and selecting Edit Customer Loyalty Center.

Here you also have the option to delete the integration if necessary.

Get started using your points data

You are now ready to work with external points in Heyloyalty. By combining your points data with campaigns and automated flows, you can create more relevant and personalized communication to your recipients.

Use points to remind customers of their balance, create urgency or target messages to the most engaged customers.

The better you use your data, the more value you create for both your business and your customers. 🚀

---