Getting started with the Platform API

A brief overview of what is needed for running using our Platform API

πŸ‘©β€πŸ« Introduction

Our API is designed to work across multiple platforms, but it may require some initial setup in order to function properly. We are currently working on building specific integrations for certain platforms, but in the meantime, this API is available for our customers to use.


There are three main considerations for setting up the platform via our API:

  1. Importing your customers
  2. The processing of Customer, Order, and Product data
  3. The handling of our webhooks

You can see the documentation for the Platform API here: Platform API documentation

πŸ™Žβ€β™‚οΈ Importing your customers

The first step for integrating with will be to ensure your customers have been properly imported into the platform.


We have a customer PUT endpoint for creating and updating customer records: PUT Customers

Given the API is platform agnostic, it’s required that you decide upon the best course of action for yourselves to ensure that your customer information is fed into this endpoint and thus, into our platform.

πŸ“Š Processing of Customer, Order, and Product data

We’ve gone through the necessity of performing your initial importing of customer data above. The next step is required to ensure that customer data is kept updated and is being created properly whenever a customer is created or updated in your store.

πŸ™β€β™€οΈ Updating Customer Data

  • You will need to hit the above endpoint with new/updated customers: PUT Customers

This needs to be done so that when new customers signup to the site, they will be enrolled in the program and can earn points/redeem rewards. This also allows us to keep track of any changes to the customers, such as their name.

πŸ›’ Managing Orders

  • One of the most important endpoints for you to handle is the Order endpoint: POST Orders


Sending us order details is crucial to ensuring that your customers are being awarded points.

We also use this endpoint to determine whenever any pending referrals are able to be marked as complete.

πŸ›οΈ Managing Products

  • One of the less important endpoints is for Products: PUT Products


There is functionality in the platform to offer rewards that are tied to a specific product. You can also create an earn rule that excludes certain products from rewarding customers with points when it has been purchased.

The product endpoint can be used to import your products into our platform so that they can be used within those earn and redeem rules.

βš™οΈ Handling our webhooks

Whenever a customer of yours interacts with our platform, be it directly through our widgets i.e redeeming a reward, or starting the referral process. Or by having their points balance increase after making an order. Our platform will dispatch the details of these changes via webhooks that you may set up.

You can see the documentation for these webhooks here: Webhook Documentation


The most important webhook you will want to ensure is set up and handled on your end is the points/redeemed topic.

This webhook is fired straight after a customer of yours uses their points to redeem a reward from within one of our widgets. This webhook will contain information you will need to use to create the discount coupon that they can apply to their next order.

To re-iterate. Our API is platform agnostic which means the method by which you create a discount coupon in your store is completely up to you, we merely provide you with the text of what that coupon should be.

What’s Next

Platform API & Webhook documentation