The Custom API Integration connects JeriCommerce with a system your team built or runs, such as a CRM or an existing loyalty program. It works in both directions:
- Your system sends data to JeriCommerce: customers and their loyalty balance and tier, so their loyalty card always shows your data.
- JeriCommerce sends events to your system: every customer event, like a card installed or a reward redeemed, as a webhook to your server.
You only need this integration when your own system is the source of truth, or when you want to receive events. To act on a JeriCommerce loyalty program from your code, like giving points or assigning a coupon, you don't need it: use the actions in Automations with an API key.
Turn it on ¶
Open the integration
In JeriCommerce, go to Settings > Integrations > API.
Add your webhook details
In Webhook URL (where you receive our updates), enter the URL of your server that will receive the events. In Secret, enter the value JeriCommerce will use to sign them, so your server can check they're real.
Choose the features
Turn on the features you need, then click Save.
| Feature | Turn it on when | Guide |
|---|---|---|
| Customer | Your system creates and updates customers in JeriCommerce. | Sync customers |
| Loyalty | Your loyalty program runs in another system, and JeriCommerce should show the balance and tier you send. | Sync loyalty information |
| Events | Your server should receive every customer event. | Events webhook |
Turning off Loyalty deletes the loyalty information (balance, tier status, and member date) of every customer in the program. Only turn it off if you're moving to another loyalty program, and send the balances again if you turn it back on.
Authentication ¶
The sync endpoints use the same API key as the rest of the API, in the api-key header. See Authentication through the API. If the integration or the feature isn't turned on, they answer 403 with API_INTEGRATION_REQUIRED, API_USERS_REQUIRED, or API_LOYALTY_REQUIRED.
Events sent to your server are signed with your Secret in the x-jericommerce-hmac-sha256 header. See the events webhook for how to check it.