Docs

Everything documented here runs in production.

Getting started The pillars REST API Webhooks Support

Getting started

A new workspace is productive the same day. The dashboard's Getting-started card walks the same path:

Connect a mailbox - Settings → Deployments. Replies, sequences and RFQ auto-quotes need a sender. DNS health (MX/SPF/DMARC) is checked daily.
Take a persona live - Personas. Your AI staff for website widgets, expo kiosks, avatar video links and voice. Going live requires passing evals (80%+) or an explicit override.
Add your products - Export → Price List, with FOB, floor and COGS prices. This powers quotes, margin visibility and automatic RFQ drafts.
Capture your first lead - import a list, prospect with Find Buyers, or let a surface catch one.
Send your first quote - the builder applies lane rates and floor-price guardrails; buyers get a hosted page and can accept online.

New workspaces can load sample data. You can remove it in one click. This lets you see how each part works before real data arrives.

The pillars

Home - the morning brief: overnight replies, approvals waiting, quotes expiring, tasks due, plus Astra, the operator copilot.
Pipeline - a drag-drop deals board over the export stages, inquiry through paid.
Leads - filterable, bulk-actionable lead desk with saved views, duplicate merge, accounts, and prospecting.
Conversations - one team inbox for email, WhatsApp, widget, kiosk and voice, with internal notes, assignment and per-message translation.
Approvals - everything AI drafted waits here for a human yes. Nothing sends itself.
Export workspace - manage quotes, orders, shipments, samples, and trade shows. Track buyers, papers, market checks, and rule checks.
Reports - period-comparable KPIs, funnel and stage flow, per-show ROI, per-surface analytics, kiosk fleet health.

REST API

Create API keys in Settings → Security (admin role required). Read-only keys see data; read-write keys act with team-member rights. Keys are shown once and revocable instantly.

# Base URL
https://api.fairshift.co

# Authenticate with your key as a bearer token
curl https://api.fairshift.co/v2/leads \
  -H "Authorization: Bearer fsk_your_key_here"

# The API mirrors what the dashboard itself calls:
#   /v2/leads   /v2/conversations   /v2/deals
#   /v2/export/quotes   /v2/orders   /v2/templates

Keys cannot touch security settings, mint other keys, or delete the account - a leaked key is containable by design.

Webhooks

Register HTTPS endpoints in Settings → Developers. Fairshift POSTs a JSON envelope the moment something happens; endpoints that keep failing are paused automatically.

# Events
lead.created        lead.updated          lead.status_changed
deal.created        deal.updated
conversation.created  conversation.message_received  message.created
quote.accepted      quote.rejected
order.created       shipment.milestone_reached

# Envelope
{
  "event": "quote.accepted",
  "timestamp": "2026-07-10T04:20:00.000Z",
  "tenantId": "…",
  "data": { … }
}

# Verify authenticity: X-Fairshift-Signature header
# sha256=HMAC_SHA256(raw_body, your_endpoint_secret)

Typical bridge: subscribe to order.created, post a voucher into your ERP. For Tally specifically, every order also exports a ready-to-import Sales voucher XML from the order page - no bridge required.

Support

Inside the dashboard, the Help icon answers product questions instantly and shows what shipped recently. A human is always reachable at support@fairshift.co. Security posture lives on the Trust Center, live health on Status.