{
"object": "STREAK",
"data": {
"merchant_key": "MERCHANT_ABC",
"customer_id": "2EE24580-B97B-4949-A65C-929CCB9B9B8D",
"partner_customer_id": "PARTNER_USER_456",
"streak_id": "11111111-2222-3333-4444-555555555555",
"streak_config_id": "66666666-7777-8888-9999-000000000000",
"event": "STREAK_COMPLETED",
"status": "COMPLETED",
"period_type": "STATEMENT",
"current_period": 12,
"completed_periods": 12,
"total_periods": 12,
"current_period_start_at": "2026-05-01T12:00:00.000Z",
"current_period_end_at": "2026-05-31T12:00:00.000Z",
"benefits": [
"BENEFIT_1"
],
"created_at": "2026-05-01T12:00:01.000Z",
"metadata": {},
"customer_metadata": {
"loyalty_id": "840012345678",
"membership_tier": "gold"
}
}
}<string>Webhooks
Streak event notification
Receive an event notification when a customer’s streak starts, progresses, completes, or fails.
WEBHOOK
Streak
{
"object": "STREAK",
"data": {
"merchant_key": "MERCHANT_ABC",
"customer_id": "2EE24580-B97B-4949-A65C-929CCB9B9B8D",
"partner_customer_id": "PARTNER_USER_456",
"streak_id": "11111111-2222-3333-4444-555555555555",
"streak_config_id": "66666666-7777-8888-9999-000000000000",
"event": "STREAK_COMPLETED",
"status": "COMPLETED",
"period_type": "STATEMENT",
"current_period": 12,
"completed_periods": 12,
"total_periods": 12,
"current_period_start_at": "2026-05-01T12:00:00.000Z",
"current_period_end_at": "2026-05-31T12:00:00.000Z",
"benefits": [
"BENEFIT_1"
],
"created_at": "2026-05-01T12:00:01.000Z",
"metadata": {},
"customer_metadata": {
"loyalty_id": "840012345678",
"membership_tier": "gold"
}
}
}<string>Headers
HMAC signature generated using shared webhook secret and webhook payload
Body
application/json
Response
200 - text/plain
Webhook received successfully.
The response is of type string.