Public API and webhooks

The API lives at api.loyever.com/v1 and speaks JSON. With it, a developer can work with members and their cards (including links to the Wallet pass), cards and rewards, transactions (earning, claiming and undo), messages and reminders.

In practice that could mean a booking system that adds a visit when an appointment is completed, or a website that shows members their balance. What you build is up to you and your developer.

It follows familiar conventions: cursor pagination; an Idempotency-Key header on every POST, so a retried request never adds points twice; a limit of 120 requests per minute per key, with a clear 429 response and Retry-After; and errors in one consistent format.

You create API keys in your dashboard, separately for live and test mode. With a test key, a developer can try everything without touching your real members or balances.

The reference documentation is generated from the API itself (OpenAPI 3.1) and published at api.loyever.com/docs, with copy-paste curl examples that use test keys.

Instead of asking the API again and again, your system can subscribe to events: a member joins, is updated or is deleted; points are added; a transaction is reversed; a reward becomes ready or is claimed; a message is delivered; a pass is installed or removed.

Each event is signed with a secret that only you and Loyever know, and receivers reject anything older than 5 minutes, so a copied request can’t be replayed later.

For example, you could create a note in your own system as soon as a reward is ready, or add a new member to your customer records the moment they join.

If your endpoint doesn’t answer within 10 seconds, Loyever tries again on a schedule that stretches from 1 minute to 48 hours. An endpoint that keeps failing for 3 days is switched off, and you get an email about it.

The delivery log shows the status and an excerpt of each response, you can retry a delivery by hand, and a Send test event button lets you check your setup before real events arrive.