Read-only API v1
Check a key, list referrers and read one referrer.
Planning for Black Friday? See what a referral program could add to your sales.
Calculate my ROIThe BLOOP API lets your server read referrer data, and webhooks tell your server when something happens. For example, your app can send each referrer their link and discount code through LINE or SMS.
What it is
Version 1 covers the Referral Program and is read-only. You can look up a referrer by email, Shopify customer id or BLOOP id, or sync all referrers, and you cannot create or change data through the API.
Webhooks notify your server of three events: a referrer joined, a referral is pending, and a referral succeeded. Each referrer includes every campaign they belong to, with their share code, referral link, personal discount code, successful referrals and referral revenue.
For your customers
01
On the API & Webhooks page, create a key and keep it on your server.
02
Look up one referrer or list referrers, including those changed since a point in time.
03
Tell BLOOP where to send events.
04
Your server receives referrer.joined, referral.pending and referral.succeeded.
For you
Steps follow the BLOOP user guide. Most stores finish setup in about 30 minutes.
The API and webhooks are available on every paid plan (Starter, Growth and Pro).
Read the guide →Use GET /v1/me to confirm the key works.
Read the guide →Use GET /v1/referrers to list referrers and GET /v1/referrers/{id} to read one by BLOOP id.
Read the guide →Add a webhook endpoint and send a webhook.test event to check delivery.
Read the guide →Subscribe to referrer.joined, referral.pending and referral.succeeded.
Read the guide →Options you control
Check a key, list referrers and read one referrer.
referrer.joined, referral.pending, referral.succeeded and webhook.test.
View delivery history, and revoke keys or disable endpoints at any time.
Guides
FAQ
Every paid plan: Starter, Growth and Pro. On other plans, API calls return 403 plan_not_eligible.
No. Version 1 is read-only.
The page shows API and webhooks as paused. Nothing is deleted, and events sent during the pause are never delivered.
More referral program features
Boost revenue, cut CAC, and build loyalty with BLOOP’s all-in-one referral & affiliate solution for Shopify.