Introduction

Tahlib Developer Docs

Tahlib's REST API is the same API the Tahlib apps (dashboard, POS, kitchen display, rider app) call. These pages describe it as it is today: what you can call, how requests are authenticated, what errors look like, and how outgoing webhooks are signed.

Start here

  • REST API overview: base URL, the X-Restaurant-Id header, error shapes, pagination and rate limits.
  • Authentication: session bearer tokens, and API keys for the read-only integration API.
  • Webhooks: subscribing an endpoint, the event list, and verifying the X-Tahlib-Signature header.
  • Receiving webhooks: a step-by-step integration guide with receivers in PHP, Laravel, Node.js and Python, test vectors and a go-live checklist.
  • Campaigns: campaign drafts. Sending is not available yet.
  • Billing for integrators: the public product catalog and the price quote.

Base URL

Every route is served under the /v1 prefix:

https://api.tahlib.com/v1      # production
http://localhost:3001/v1       # local development

Finding a route

Outside production, the API lists every route it serves:

curl http://localhost:3001/v1/_routes

Each entry gives the method, the full path, and the controller and handler behind it. Production does not serve this route.

Sources

  • Global /v1 prefix and port: apps/api/src/main.ts
  • Production API host: docs/integrations/whatsapp-cloud-api.md, infrastructure/coolify/README.md
  • Route catalog: apps/api/src/health/routes.controller.ts