Quick Start & Architecture
Fizmoh Cloud provides a multi-tenant API. Every request made with a tenant API key automatically operates within that tenant's isolated database scope.
1. WhatsApp API
Send texts, media, interactive list/button messages, and approved Meta templates.
2. CRM & Orders
Sync customer contacts, stages, tags, bookings, and auto-generate AmwalPay checkout links.
3. Developer Webhooks
Subscribe to real-time events signed with HMAC SHA-256 secrets.
Authentication
Generate your secret API key in Settings → API Keys & Docs. Keys begin with the prefix fiz_live_....
Pass your API key in either of the following HTTP headers:
HTTP Request HeadersREST API
X-API-Key: fiz_live_your_secret_key_here
# or
Authorization: Bearer fiz_live_your_secret_key_hereIntegration Code Examples
1. Send WhatsApp Message (cURL)
cURL — Send Text MessageREST API
curl -sS -X POST https://app.fizmoh.cloud/api/external/v1/whatsapp/send \
-H 'Content-Type: application/json' \
-H 'X-API-Key: fiz_live_REPLACE_ME' \
-d '{
"phone": "+96898821965",
"type": "text",
"text": "Your booking ORD-9821 is confirmed! View details: https://app.fizmoh.cloud"
}'2. Node.js Example
Node.js (TypeScript / JavaScript)REST API
const res = await fetch("https://app.fizmoh.cloud/api/external/v1/whatsapp/send", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": process.env.FIZMOH_API_KEY,
},
body: JSON.stringify({
phone: "+96898821965",
text: "Welcome to Fizmoh Cloud!",
}),
});
const data = await res.json();
console.log("Message ID:", data.messageId);REST API Endpoint Catalog
External V1 Public APIs (Developer & Integration)
| Method | Path | Description |
|---|---|---|
| POST | /api/external/v1/whatsapp/send | Send text, media (image/doc/video), interactive buttons, and template messages |
| GET | /api/external/v1/whatsapp/templates | List approved Meta WhatsApp templates with parameters |
| POST | /api/external/v1/whatsapp/broadcast | Batch dispatch templates to up to 500 phone numbers |
| GET | /api/external/v1/customers | Search and list CRM contacts with pagination and stage filter |
| POST | /api/external/v1/customers | Create or upsert CRM contact details and tags |
| GET/PATCH/DELETE | /api/external/v1/customers/:id | Retrieve, update, or remove a contact record |
| GET | /api/external/v1/orders | Query bookings and orders with status and date filters |
| POST | /api/external/v1/orders | Create order and generate instant AmwalPay customer checkout URL |
| GET/POST/DELETE | /api/external/v1/webhooks | Manage HTTPS developer webhook subscriptions |
Platform & Workspaces
| Method | Path | Description |
|---|---|---|
| GET | /api/health | Public service and database health check |
| GET | /api/features | Enabled modules for the current workspace |
| GET | /api/dashboard | Workspace metrics and operational summary |
| GET | /api/search?q=... | Search contacts, orders, and conversations |
| GET | /api/tenant/health | Tenant usage and health summary |
| GET | /api/tenant/export | Authenticated tenant data export |
| GET | /api/plans/public | Public plan catalog |
Tours, Bookings & Calendar
| Method | Path | Description |
|---|---|---|
| GET/POST | /api/tours | List or create tours |
| GET/PUT/DELETE | /api/tours/:id | Read, edit, or remove a tour |
| GET/POST | /api/slots | Manage tour availability slots |
| GET/POST | /api/orders | List or create customer orders |
| GET/PUT/DELETE | /api/orders/:id | Read, update, or cancel an order |
| POST | /api/orders/:id/refund | Request an order refund |
| POST | /api/orders/:id/reschedule | Reschedule an order |
| POST | /api/orders/:id/send-confirmation | Send a WhatsApp confirmation message |
| GET | /api/calendar | Booking calendar data |
| GET | /api/calendar/ics | Calendar subscription/download feed |
WhatsApp & Omnichannel Commerce
| Method | Path | Description |
|---|---|---|
| GET/POST | /api/whatsapp/accounts | List or connect WhatsApp numbers |
| POST | /api/whatsapp/send | Send freeform text or interactive messages |
| GET/POST | /api/campaigns | Manage broadcast promotional campaigns |
| POST | /api/campaigns/:id/send | Trigger campaign broadcast to audience |
| POST | /api/whatsapp/templates/sync | Synchronize templates from Meta |
| GET/POST | /api/botflows | Visual botflow logic graphs and execution |
| POST | /api/amwalpay/create-session | Initiate AmwalPay payment session |
| POST | /api/amwalpay/webhook | Verify payment notifications |
| GET | /api/payments | Payment records and verification queue |
Developer Webhook Events
Subscribe your backend systems to real-time events triggered by customer interactions, incoming messages, and payments.
message.received— Inbound WhatsApp message received from a customer.message.delivered— Message delivery receipt confirmation.order.created— Customer created an order / booking.order.paid— Verified AmwalPay payment received.
Ready to integrate?
Download the Postman collection or view the OpenAPI specification.