API reference

v1 · Public

Webhooks

Configure outbound notifications in Company Settings → Developer. Webhooks are company-wide (not per API key).

Events

EventWhen
quote.createdAfter a quotation is successfully created via POST /quotes
order.createdAfter a web order is successfully created via POST /orders

Telegram

Create a bot with @BotFather, then add the bot token and chat ID in Developer settings. EquityPOS sends a formatted message when events fire.

HTTP (generic)

POST JSON to your URL. Use this for Zapier, Make, custom servers, or WhatsApp Business API middleware. If you set a secret, we send it in the X-EquityPOS-Webhook-Secret header.

json
{
  "event": "quote.created",
  "companyId": "…",
  "locationId": "…",
  "timestamp": "2026-05-31T12:00:00.000Z",
  "data": {
    "quotationId": "…",
    "number": "QT000123",
    "customerName": "Acme Inc",
    "totalWithTax": "1250.00",
    "locationName": "Main Store",
    "lineCount": 3
  }
}

Product catalog scope

In Developer settings you can expose all products or selective access: specific products (fixed IDs), categories (dynamic, new products in those categories are included), or models (dynamic). Requests for products outside scope return 404 or are rejected on quote lines.