All Collections
General API API

Create a bespoke loyalty solution using the API.

Mollie Herbert avatar
Written by Mollie Herbert
Updated over a week ago

Introduction πŸ“–

This API Documentation is targeted at developers and can be used to create bespoke solutions for merchants who do not use Shopify.



βœ… Plus plan or higher

Full API Documentation

Launch the full API documentation below πŸ‘‡

Where to locate your API Keys

πŸ— You can find your API Key from the dashboard.

  • Go to Settings >> API Settings or Shopify Settings (This is dependent on your platform)

  • Select Platform API Settings and your API key will be listed here

  • Send the API Key with every request in a x-api-key header.

Webhooks has the ability to push events to you via webhooks when things happen on our system. The below table is a list of all topics we support. Each topic also has its own page which describes the body of the webhook.

Supported Webhook Topics πŸ‘‡

Webhook Topic



Triggered when a customer is updated.


Triggered when a customer's tier has changed.


Triggered when a customer has earned points.


Triggered when a customer has redeemed points.


Triggered when a referral process has started. The webhook body will contain details about who was referred as well as which customer the referral belongs to. A referral is considered started when the customer's friend submits their email address.


Triggered when a referral process has completed. A referral is considered completed once the friend has completed an order with either the discount code awarded from starting a referral or using the email which they submitted to start the referral process.

Did this answer your question?