Skip to content

Planning for Black Friday? See what a referral program could add to your sales.

Calculate my ROI

API and webhooks

Connect your own systems to your referral program

The 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

API and webhooks, explained

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

How it works on your store

  1. 01

    Create an API key

    On the API & Webhooks page, create a key and keep it on your server.

  2. 02

    Call the API

    Look up one referrer or list referrers, including those changed since a point in time.

  3. 03

    Add a webhook endpoint

    Tell BLOOP where to send events.

  4. 04

    React to events

    Your server receives referrer.joined, referral.pending and referral.succeeded.

For you

Set it up in BLOOP

Steps follow the BLOOP user guide. Most stores finish setup in about 30 minutes.

  1. 01. Check your plan

    The API and webhooks are available on every paid plan (Starter, Growth and Pro).

    Read the guide →
  2. 02. Create a key and test it

    Use GET /v1/me to confirm the key works.

    Read the guide →
  3. 03. List or read referrers

    Use GET /v1/referrers to list referrers and GET /v1/referrers/{id} to read one by BLOOP id.

    Read the guide →
  4. 04. Add an endpoint

    Add a webhook endpoint and send a webhook.test event to check delivery.

    Read the guide →
  5. 05. Handle events

    Subscribe to referrer.joined, referral.pending and referral.succeeded.

    Read the guide →

Options you control

Make it fit your store

Read-only API v1

Check a key, list referrers and read one referrer.

Three events plus a test event

referrer.joined, referral.pending, referral.succeeded and webhook.test.

Delivery history

View delivery history, and revoke keys or disable endpoints at any time.

Guides

Go deeper

FAQ

API and webhooks: common questions

Which plans include the API?

Every paid plan: Starter, Growth and Pro. On other plans, API calls return 403 plan_not_eligible.

Can I create referrers through the API?

No. Version 1 is read-only.

What happens if I downgrade?

The page shows API and webhooks as paused. Nothing is deleted, and events sent during the pause are never delivered.

More referral program features

Turn Your Customers Into Your Best Marketers

Boost revenue, cut CAC, and build loyalty with BLOOP’s all-in-one referral & affiliate solution for Shopify.