Connect your tools
Loyalty inside your own systems
Larger businesses often run their own till or app. The Zawadi API lets that system enrol customers, check balances and history, award and redeem points, and list rewards, while webhooks tell your system when something happens.
Enterprise plan
API and webhooks
The Zawadi API lets an Enterprise customer connect its own POS or app to its loyalty programme over REST. It can enrol customers, check balances and history, award and redeem points and list rewards, using an API key, with optional idempotency keys and signed webhooks for events such as points awarded.
What you can do
- Send an X-Idempotency-Key with POST requests so a retry never awards points twice.
- Webhooks carry an X-Zawadi-Signature header (HMAC-SHA256) and are retried 3 times.
- 500 requests a day by default.
- Included on the Enterprise plan.
POST /api/v1/points/award
X-API-Key: your-api-key
X-Idempotency-Key: sale-10293
Content-Type: application/json
{
"phone": "0712345678",
"amount_spent_kes": 1200,
"note": "Till 2"
}What changes
Before and after Zawadi
Before
With Zawadi
-
BeforeStaff typing every sale into two systems
Your till awards points as part of the sale
-
BeforeRetries that award points twice
Idempotency keys that make a repeat request safe
API and webhooks
How it works
-
Get your API key
Create a key in your Enterprise dashboard and send it in the X-API-Key header.
-
Call the endpoints
Enrol customers, check balances and history, award points with the amount spent, redeem rewards and list your rewards.
-
Listen for events
Add a webhook URL to receive points.awarded, customer.enrolled and automation events, signed so you can verify they came from Zawadi.
Example
A supermarket till
A mini-mart's POS calls the award endpoint with the customer's phone number and the basket total at checkout, using the receipt number as the idempotency key. A webhook tells its own app when the points land.
Industries
Popular with
- Restaurants Points on every bill, an SMS offer for your quiet nights, and a birthday treat from the kitchen.
- Pharmacies Reward regular customers on everyday health, baby and beauty buys, and remind them when it is time to come back.
- Boutiques Reward repeat shoppers, tell your best customers first when new stock lands, and sell gift vouchers.
Questions
API and webhooks questions
Which plan includes the API?
The API and webhooks are part of the Enterprise plan.
What can the API do?
Enrol customers, look up balances and history by phone number, award points, redeem rewards and list your active rewards.
How do I know a webhook came from Zawadi?
Each webhook includes an X-Zawadi-Signature header, an HMAC-SHA256 of the body made with your webhook secret. Check it before trusting the payload.
Features