Skip to main content
The Need Alert API lets your business system do, with no one at the screen, what you do today in the dashboard.

​
What it’s for

Back in stock

Your ERP sends the alert when a SKU’s stock is positive again.

Appointment cancelled

Your clinic’s booking system notifies the specialty’s subscribers when a patient cancels.

Items in sync

Your online store creates and updates items from its own products.

Balance under control

Your finance team tracks the credit balance and statement.

​
What is available

  • API keys created by the chain owner in the dashboard, with a name, allowed units, and permissions. The key is shown only once and can be rotated or revoked at any time. See Authentication.
  • Items: list, create, edit, and archive, with an external reference so you can use your own system’s code (such as the SKU), and get the QR code.
  • Dispatches: estimate the cost, send now or schedule, track the status, reschedule, and cancel. See First request.
  • Credits: check the balance and statement.
  • Idempotency: the Idempotency-Key header so a retry after a network failure doesn’t send the alert twice.
Every dispatch through the API follows the same rules as the dashboard: the cost is calculated first, the balance is checked, and the charge is 1 credit per person notified.

​
Where to start

  1. Read Authentication and create the key in the dashboard.
  2. Follow First request to your first alert.
  3. Look up each endpoint in the Endpoints group of this tab, and the general rules in Conventions.
  4. Follow changes in the Changelog.