English
Go to website
Back
Articles on:
Webhook API
Real-time notifications for loyalty events.
Overview
Overview
Push loyalty events from BLOY to your systems in real time, instead of polling for changes. Register an HTTPS endpoint against a topic, and BLOY sends it a signed POST the moment something happens — a customer earns points, reaches a new VIP tier, or claims a referral reward. Getting started API base URL:https://api.bloy.io/rest-api/v1 Plan requirements Webhook API require the BLOY Unlimited plan. What you can do Subscribe an endpoint to a topic, or to a w
Few readers
Security
Security
Authentication Two directions, two different credentials. Never use one in place of the other. Direction Credential Carried in You → BLOY (manage webhook subscriptions) Public API key Authorization header you send BLOY → you (event deliveries) Subscription signing secret X-Bloy-Hmac-Sha256 header BLOY sends Calling the BLOY API Authorization: Bearer YOUR_PUBLIC_API_KEY You will find the key in the BLOY app in your Shopify admin; c
Few readers
API Reference
API Reference
API reference Base URL: https://api.bloy.io/rest-api/v1/webhooks/subscription Create Subscription POST https://api.bloy.io/rest-api/v1/webhooks/subscription Register an endpoint for a topic. Returns the signing secret — the only time it is ever exposed. Headers Name Type Required Example Authorization string Required Bearer YOUR_PUBLIC_API_KEY Content-Type string Required application/json Body Name | Type | Required | Descri
Few readers
Event Delivery
Event Delivery
Request format BLOY sends a POST request with a JSON body and these headers: Header Description X-Bloy-Topic The event topic, for example points/earned X-Bloy-Event-Id Unique event id, for example 9f2c7a1b4e8d3c6f0a5b2e91. Stable across retries X-Bloy-Shop-Domain The .myshopify.com domain the event belongs to X-Bloy-Api-Version Webhook API version, currently 2026-01 X-Bloy-Hmac-Sha256 | HMAC-SHA256 of the raw body, hex encoded, sign
Few readers
Webhook Events
Webhook Events
Topic catalogue Points Topic Fires when points/earned A customer earns points from any earning rule points/redeemed A customer spends points on a reward points/expired Points expire under the expiration policy points/reversed Points are taken back because an order was refunded, cancelled, or unfulfilled points/adjusted A balance changes outside the rules above — admin edit, import, store credit, or Shopify Flow `points/expiring_so
Few readers