Skip to content

Developers

Build on RapBooster with the public API.

RapBooster's REST API lets any site, app or server sell from a workspace's store, work with leads and contacts, send WhatsApp and email, and receive signed webhooks. API keys are free in every workspace, and the typed @rapbooster/sdk covers every endpoint.

Start the Free plan, then create a key in Settings.

  • Free API keys
  • 300 requests a minute
  • Signed webhooks
  • Test keys
Create a lead
curl https://api.rapbooster.com/api/v1/public/v1/crm/leads \
  -H "Authorization: Bearer rb_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Asha Verma", "mobile": "+919876543210" }'

Quick start

From key to first call in three steps

  • 1. Create a keyIn Settings › Developer, name it and pick its scopes. A secret key is shown once; a publishable key for a site or app can be shown again.
  • 2. Call the APISend it as a bearer token. A key acts as the member who made it, never more.
  • 3. Listen for eventsAdd an https endpoint and receive signed lead and message events as they happen.

Store API

Sell from your own site or app

The Store API serves a workspace's catalogue, buyer accounts (phone code, Google, Apple), carts, Razorpay checkout, orders, subscriptions, reviews and trade accounts under /public/v1/store. Use a publishable key in the browser or app and send the signed-in buyer's X-Buyer-Token.

List products
curl "https://api.rapbooster.com/api/v1/public/v1/store/products?limit=12" \
  -H "Authorization: Bearer rb_pk_live_..."

Docs

Reference and guides

Authentication

Scopes keep every key to its job

Every call needs the key's scope and the creating member's own right to the same thing. App endpoints also need the workspace id in x-workspace-id. Keys are stored only as a hash. A publishable key (rb_pk_…) holds only storefront and answers only its allowed origins.

App scopes

  • crm:readCRM leads, their counts and lead statuses
  • marketing:readAudience contacts and groups, social accounts and posts
  • marketing:writeCreate and schedule social posts
  • inbox:readThe social inbox
  • billing:readInvoices and credit notes
  • store:readStore items, orders, settings and Store sync
  • store:writeCreate, change and delete store items
  • support:readSupport tickets and categories
  • orders:readOrders and their summary

Public API v1 scopes

  • crm:readRead leads
  • crm:writeCreate and update leads
  • marketing:readRead contacts
  • marketing:writeCreate and update contacts
  • inbox:writeSend WhatsApp and email
  • inbox:readRead a message's delivery status
  • webhooks:manageAdd, change and delete webhook endpoints
  • storefrontThe Store API (the one scope a publishable key holds)
  • 300 requests a minutePer key. Over that you get 429 with code PUBLIC_API_RATE_LIMITED.
  • Keys are freeSending costs what the same send costs in the app; email goes through your own mailbox.
  • Test keysAn rb_test_ key reads real data, makes dry-run sends and refuses every other change.
  • Predictable shapessnake_case fields. A record is { data }, a list { items, meta }, an error { code, message, details?, correlation_id }.

Endpoints

Every endpoint, from the live document

Read from the API's own OpenAPI document, so this list never drifts from what runs. Paths start after the API base (https://api.rapbooster.com/api/v1); open one for its parameters and a Try it panel.

Store API60 endpoints
Public API: Contacts4 endpoints
Public API: Leads4 endpoints
Public API: Messages3 endpoints
Public API: Webhooks4 endpoints
Billing: Invoices4 endpoints
Billing: Offers5 endpoints
Contact Groups2 endpoints
Contacts2 endpoints
Leads3 endpoints
  • GET/crm/leadsBeta · crm:read

    List leads

  • GET/crm/leads/{id}Beta · crm:read

    Get a lead with its default billing detail and header fields

  • GET/crm/leads/countsBeta · crm:read

    How many leads are in each status and each sidebar view

Leads: Settings1 endpoint
Orders3 endpoints
  • GET/ordersBeta · orders:read

    List goods orders

  • GET/orders/{id}Beta · orders:read

    An order with its lines and shipments

  • GET/orders/summaryBeta · orders:read

    Overview and sidebar counts: to ship, shipped in 7 days, delivered, cancelled, to pack, ready to ship, in transit, issues, returns, COD to collect

Site API: CRM1 endpoint
Site API: HRMS5 endpoints
Site API: Marketing4 endpoints
Site API: Workspace1 endpoint
Social7 endpoints
Store7 endpoints
  • GET/store/itemsBeta · store:read

    The store's items

  • POST/store/itemsBeta · store:write

    Add catalogue items to the store

  • DELETE/store/items/{id}Beta · store:write

    Take an item off the store (the catalogue item stays)

  • PATCH/store/items/{id}Beta · store:write

    Show or hide, action, per-item delivery, order, featured

  • GET/store/ordersBeta · store:read

    Store orders, newest first (search: buyer, number, phone)

  • GET/store/orders/{id}Beta · store:read

    One store order, with its payments and shipping

  • GET/store/settingsBeta · store:read

    The store's settings (defaults until first saved)

Store: Marketplaces12 endpoints
Store: Sync6 endpoints
Support3 endpoints

Webhooks

Signed events, retried until you answer

Events include store.order.paid, shipped, delivered, cancelled and refunded, store.subscription.changed, store.buyer.created and deleted, inventory.stock.low, crm.enquiry.created, lead.created, lead.updated, message.status and more (the full list is in Settings and the webhooks guide). Each POST is signed with HMAC-SHA256 of “<t>.<raw body>” and your endpoint's secret: verify it on the raw body, refuse an old timestamp.

Webhooks
POST https://your-app.example/hooks/rapbooster
X-RapBooster-Event: lead.created
X-RapBooster-Signature: t=1767225600,v1=5f2c…
 
{
  "id": "evt_9c1e…",
  "event": "lead.created",
  "created_at": "2026-10-30T09:12:45Z",
  "data": { "id": "4182", "name": "Asha Verma" }
}

Downloads

OpenAPI, Postman and SDKs

Generated from the same document as the list above, so they never drift.

Changelog

Changes and deprecations

Stable endpoints never break without 90 days' notice here; Beta endpoints may change, also listed here.

  1. Store API, publishable keys and the SDK

    The Store API (public/v1/store: catalogue, buyer sign-in, carts, Razorpay checkout, orders, subscriptions, reviews, trade accounts) with publishable keys (rb_pk_…) for sites and apps, store webhooks (store.order.paid and 13 more), the API reference with Try it, guides, and @rapbooster/sdk 0.2 with typed helpers. Settings › Developer is now its own permission.

  2. New paths and scope names

    Breaking: public/v1/leads is now public/v1/crm/leads, public/v1/contacts is public/v1/marketing/contacts and public/v1/messages is public/v1/inbox/messages. The scopes leads:* and contacts:* are now crm:* and marketing:*, and the app scopes follow the apps: crm, marketing, inbox and billing. Keys you already have keep working with their scopes renamed; change the paths in your code.

  3. Platform API

    App endpoints for leads, contacts, sales, support and orders (Beta), test keys, Idempotency-Key, IP allow-lists, key expiry and rolling, a request log, platform webhooks with a delivery log, resend and secret rotation. Webhooks now retry for 3 days.

  4. Public API v1

    Leads, contacts, WhatsApp and email sends, delivery status and webhooks. Stable.

Questions

About the API

What is a publishable key?

A key you may ship inside a website or a mobile app. It opens only the Store API, answers only the origins you list (exact https origins; http://localhost on test keys) and can be shown again in Settings. Secret keys stay on servers.

Who can create keys and webhooks?

The workspace owner and any member whose role holds Developer (Settings › Developer). A key acts as the member who made it and stops if they lose that permission.

Does the API cost extra?

No. API keys are free in every workspace. A WhatsApp or email sent through the API costs what the same send costs in the app.

What can a key do?

Only what its scopes allow and only what the member who created it may do. Revoke a key in Settings and it stops at once.

How are webhook deliveries retried?

A non-2xx answer or a network error is retried with growing gaps (30 seconds, then doubling up to 12 hours) for 3 days. Each event has a stable id so you can ignore repeats. An endpoint that keeps failing for 3 days is turned off and the workspace is emailed; resend any delivery from the delivery log.

How do I rotate a webhook secret or an API key?

Rotate the secret in Settings: for 24 hours each delivery carries two v1= signatures, one per secret, so you can switch without missing one. Roll a key the same way: the old one keeps working for 24 hours.

What if my request is retried?

Send an Idempotency-Key header on a POST or PATCH. A retry within 24 hours gets the first answer again (Idempotent-Replayed: true); the same key with a different body is refused with 422.

Is there a daily limit?

Each key may make 300 requests a minute. Your plan may also set requests a day for the whole workspace; past it, calls get 429 PUBLIC_API_DAILY_CAP until midnight IST.

What do Stable and Beta mean?

Stable endpoints never break: a breaking change gets a new path and 90 days' notice in the changelog. Beta endpoints may still change, announced in the changelog.

Is there an SMS endpoint?

No. The API covers leads, contacts, WhatsApp and email sends, delivery status and webhooks.

Get your free API key.

Start the Free plan, then create a key in Settings. No card needed.