Fizmoh — Automate, Connect, Grow
Fizmoh API Reference & Manual

REST API Reference & Operator Manual

Build enterprise integrations with Fizmoh Cloud. Send WhatsApp messages, trigger marketing broadcasts, manage CRM contacts, sync orders, and listen to real-time webhook events.

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_here

Integration 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);

E-Commerce: WooCommerce & Shopify Integration

Connect your online store directly to WhatsApp to automate high-intent conversational workflows: recover abandoned shopping carts with 1-click restoration links, send interactive order confirmations with tracking buttons, and capture compliant WhatsApp newsletter subscribers.

Official Pluginv1.0.0 · 17 KBHPOS Compatible

Fizmoh Connect for WooCommerce

Real-time checkout typing capture, 1-click deep-link cart recovery, automatic order & AST/ShipStation shipment tracking sync, WhatsApp opt-in checkbox, and storefront chat widgets.

HPOS Certified: Works with modern WooCommerce High-Performance Order Storage.
Typing Capture: Detects customer phone before form submission to recover 3x more carts.
Action Buttons: Out-of-the-box WhatsApp buttons for order tracking, discounts, and support.

WooCommerce Setup Instructions

  1. Download the plugin package above or navigate to Settings → E-Commerce & Stores in your Fizmoh dashboard.
  2. In WordPress, navigate to Plugins → Add New → Upload Plugin and upload fizmoh-connect-for-woocommerce.zip.
  3. Activate the plugin, then go to WooCommerce → Fizmoh Connect Settings.
  4. In Fizmoh, under Settings → E-Commerce & Stores → Connected Stores, click Add Store Connection to generate your unique Store Key.
  5. Paste the Store Key into the WordPress settings page and click Test Connection.

Default Interactive WhatsApp Templates with Action Buttons

Fizmoh dispatches high-converting interactive templates out of the box. Merchants can also map custom Meta-approved templates in the dashboard:

EventTrigger DescriptionAction Button 1 (URL)Action Button 2 (Quick Reply)
ORDER_CREATEDNew checkout completed by customer[Track Order][Contact Support]
ORDER_SHIPPEDOrder dispatched with carrier tracking[Track Shipment][Contact Support]
CART_ABANDONED_STEP115-minute checkout nudge[Complete Order] (1-Click Rebuild)[Need Help?]
CART_ABANDONED_STEP24-hour discount incentive[Claim 10% Off] (Auto-Discount)[Ask Question]
NEWSLETTER_WELCOMECustomer opted in at checkout / shortcode[Claim 10% Gift]-

Shopify Webhook Configuration

For Shopify stores, configure your webhooks pointing to https://app.fizmoh.cloud/api/ecommerce/webhooks/shopify. In your Fizmoh dashboard, paste your Shopify Shared Secret to verify HMAC-SHA256 signatures (X-Shopify-Hmac-Sha256) automatically.

REST API Endpoint Catalog

External V1 Public APIs (Developer & Integration)

MethodPathDescription
POST/api/external/v1/whatsapp/sendSend text, media (image/doc/video), interactive buttons, and template messages
GET/api/external/v1/whatsapp/templatesList approved Meta WhatsApp templates with parameters
POST/api/external/v1/whatsapp/broadcastBatch dispatch templates to up to 500 phone numbers
GET/api/external/v1/customersSearch and list CRM contacts with pagination and stage filter
POST/api/external/v1/customersCreate or upsert CRM contact details and tags
GET/PATCH/DELETE/api/external/v1/customers/:idRetrieve, update, or remove a contact record
GET/api/external/v1/ordersQuery bookings and orders with status and date filters
POST/api/external/v1/ordersCreate order and generate instant AmwalPay customer checkout URL
GET/POST/DELETE/api/external/v1/webhooksManage HTTPS developer webhook subscriptions

Platform & Workspaces

MethodPathDescription
GET/api/healthPublic service and database health check
GET/api/featuresEnabled modules for the current workspace
GET/api/dashboardWorkspace metrics and operational summary
GET/api/search?q=...Search contacts, orders, and conversations
GET/api/tenant/healthTenant usage and health summary
GET/api/tenant/exportAuthenticated tenant data export
GET/api/plans/publicPublic plan catalog

Tours, Bookings & Calendar

MethodPathDescription
GET/POST/api/toursList or create tours
GET/PUT/DELETE/api/tours/:idRead, edit, or remove a tour
GET/POST/api/slotsManage tour availability slots
GET/POST/api/ordersList or create customer orders
GET/PUT/DELETE/api/orders/:idRead, update, or cancel an order
POST/api/orders/:id/refundRequest an order refund
POST/api/orders/:id/rescheduleReschedule an order
POST/api/orders/:id/send-confirmationSend a WhatsApp confirmation message
GET/api/calendarBooking calendar data
GET/api/calendar/icsCalendar subscription/download feed

E-Commerce & Store Connections

MethodPathDescription
GET/api/ecommerce/plugin/downloadDirect binary download for the official Fizmoh Connect WooCommerce .zip plugin
GET/POST/api/ecommerce/storesList or connect WooCommerce and Shopify stores & generate API pairing keys
POST/api/ecommerce/ordersSync order status transitions, tracking numbers, and auto-dispatch interactive templates
GET/POST/api/ecommerce/cart-abandonedIngest checkout typing capture, list abandoned carts, & track recovery stages
POST/api/ecommerce/newsletterCapture WhatsApp newsletter opt-ins with consent timestamps & issue discount gifts
GET/POST/api/ecommerce/templatesFetch event definitions, preview button templates, map Meta templates, & send tests
POST/api/ecommerce/webhooks/shopifyInbound Shopify webhook receiver with HMAC SHA-256 verification
GET/api/cron/ecommerce-recoveryMulti-stage automated recovery scheduler (15m, 4h, 24h)

WhatsApp & Omnichannel Commerce

MethodPathDescription
GET/POST/api/whatsapp/accountsList or connect WhatsApp numbers
POST/api/whatsapp/sendSend freeform text or interactive messages
GET/POST/api/campaignsManage broadcast promotional campaigns
POST/api/campaigns/:id/sendTrigger campaign broadcast to audience
POST/api/whatsapp/templates/syncSynchronize templates from Meta
GET/POST/api/botflowsVisual botflow logic graphs and execution
POST/api/amwalpay/create-sessionInitiate AmwalPay payment session
POST/api/amwalpay/webhookVerify payment notifications
GET/api/paymentsPayment 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.