Reference
Webhooks
Receive real-time notifications for events happening in your application.
Info: Webhooks allow you to synchronize your external systems with member and loyalty program activity.
List Webhook Events
GET
List Events
public
/api/v1/reference/webhook-events
Retrieve the list of all available webhook event types.
Response
{
"success": true,
"data": {
"events": {
"member_joined": "When a new member joins a card",
"points_earned": "When a member earns points from a purchase",
"..."
}
}
}Security & Verification
To verify that the webhook originated from our server, we include an HMAC SHA-256 signature in the X-Webhook-Signature header.
Verification Example (PHP)
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'];
$secret = 'your_app_secret';
$computedSignature = hash_hmac('sha256', $payload, $secret);
if (hash_equals($computedSignature, $signature)) {
// Webhook is valid
}Events Reference
| Event | Description | Product |
|---|---|---|
member_joined |
When a new member joins a card | Shared |
member_left |
When a member leaves a card | Shared |
claim_request_created |
When a member submits a reward claim request | Loyalty |
claim_request_processed |
When a claim request is approved or rejected | Loyalty |
points_earned |
When a member earns points from a purchase | Loyalty |
points_redeemed |
When a member redeems points for a reward | Loyalty |
stamps_added |
When stamps are added to a member card | Loyalty |
stamps_redeemed |
When stamps are redeemed for a reward | Loyalty |
cashback_earned |
When a member earns cashback from a purchase | Cashback |
cashback_redeemed |
When a member redeems cashback | Cashback |
coins_issued |
When coins are issued to a member | Coins |
coins_spent |
When a member spends coins at a club | Coins |