Developer Documentation

Integrate SyncBot with any website, app, store, or customer system.

SyncBot connects external products to WhatsApp automation, approved template messaging, AI lead intelligence, commerce workflows, ad attribution, website chat, and revenue operations.

Start setup Security overview

Integration Architecture

SyncBot is designed to sit between customer touchpoints and WhatsApp-led revenue workflows.

Capture

Receive leads, messages, form fills, app events, ad clicks, orders, bookings, and cart activity.

Automate

Match events to approved templates, flow-builder journeys, routing rules, AI scoring, and notifications.

Engage

Send compliant WhatsApp template messages, move chats into the inbox, and track revenue context.

Authentication

All server APIs use scoped bearer tokens generated inside the SyncBot webapp.

  1. Open app.syncbot.cloud, go to Integrations or Admin Setup, and create an integration token.
  2. Select only the abilities required by your integration, such as forms.write, templates.send, events.write, or commerce.write.
  3. Store the token in your backend secret manager or environment file. Do not ship it inside browser or mobile app bundles.
  4. Call APIs with Authorization: Bearer YOUR_SYNCBOT_TOKEN.

Supported Integration Channels

The same API layer can connect lightweight websites and enterprise systems.

Mobile apps

Send lifecycle events from your backend after app signup, booking, payment, order, or support actions.

Web apps

Connect SaaS dashboards, portals, CRMs, and internal tools using server-side API calls.

Websites

Capture forms from WordPress, Webflow, Shopify, Laravel, Next.js, HTML, and custom landing pages.

Ecommerce

Sync stores, products, orders, abandoned carts, and payment events for WhatsApp workflows.

Ads

Track direct ad clicks and click-to-WhatsApp source data for revenue attribution.

Chatbot widget

Embed website chat to capture visitor questions and move conversations into SyncBot.

Core Endpoints

Use these production endpoints from your backend or serverless functions.

POST
https://syncbot.cloud/api/v1/contacts
Create or update a contact.
POST
https://syncbot.cloud/api/v1/forms/capture
Capture a website form and trigger mapped automation.
POST
https://syncbot.cloud/api/v1/events
Trigger a custom business event.
POST
https://syncbot.cloud/api/v1/messages/template
Send an approved WhatsApp template.
POST
https://syncbot.cloud/api/v1/commerce/orders
Sync order events.
POST
https://syncbot.cloud/api/v1/commerce/abandoned-carts
Trigger cart recovery.
POST
https://syncbot.cloud/api/v1/ads/clicks
Track ad source and campaign metadata.
GET
https://syncbot.cloud/api/widget/syncbot.js
Load the website chatbot widget.

WooCommerce, Shopify, and Website Webhooks

Create the store inside SyncBot Commerce first, then copy the generated delivery URL and secret.

POST
https://syncbot.cloud/api/integrations/{tenant_uuid}/woocommerce/{store_uuid}
Use this as the WooCommerce webhook delivery URL. Configure the SyncBot store secret as the WooCommerce webhook secret so SyncBot can validate X-WC-Webhook-Signature.
POST
https://syncbot.cloud/api/integrations/{tenant_uuid}/shopify/{store_uuid}
Use this for Shopify order and checkout webhooks. SyncBot validates X-Shopify-Hmac-Sha256 using the store webhook secret.
POST
https://syncbot.cloud/api/integrations/{tenant_uuid}/website
Use this for websites and custom apps when you want a simple signed event endpoint instead of bearer-token API calls.

Implementation Examples

These examples show common integration patterns. Use your production token, tenant, and template values.

curl -X POST "https://syncbot.cloud/api/v1/forms/capture" \
  -H "Authorization: Bearer YOUR_SYNCBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "form_name": "Contact sales",
    "page_url": "https://example.com/contact",
    "source": "website",
    "contact": {
      "name": "Aarav Sharma",
      "phone": "919999999999",
      "email": "aarav@example.com"
    },
    "message": "Need pricing details",
    "fields": {
      "company": "NeonKart",
      "team_size": "25"
    }
  }'
await fetch("https://syncbot.cloud/api/v1/events", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_SYNCBOT_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    event_name: "booking.confirmed",
    payload: {
      contact: { name: "Priya", phone: "919999999999" },
      booking_id: "BK-1042",
      service: "Demo consultation",
      scheduled_at: "2026-06-24T10:30:00+05:30"
    }
  })
});
await fetch("https://syncbot.cloud/api/integrations/YOUR_TENANT_UUID/website", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    secret: "STORE_WEBHOOK_SECRET",
    store_uuid: "STORE_UUID",
    event: "cart.abandoned",
    contact: { name: "Riya", phone: "919999999999", email: "riya@example.com" },
    cart: {
      external_id: "cart_1042",
      checkout_url: "https://example.com/checkout/cart_1042",
      total_paise: 249900,
      currency: "INR",
      items: [{ name: "Starter Plan", quantity: 1 }]
    }
  })
});
<script
  src="https://syncbot.cloud/api/widget/syncbot.js"
  data-tenant="YOUR_TENANT_UUID"
  data-position="right"
  data-accent="#08764d"
  async></script>

Go-Live Checklist

Recommended production sequence for a reliable SyncBot integration.

  1. Connect and verify WhatsApp Cloud API inside SyncBot.
  2. Sync approved templates and confirm template language names.
  3. Create a scoped bearer token for the integration surface.
  4. Configure event-trigger rules for forms, orders, payments, bookings, or carts.
  5. Send test events from staging and verify messages in WhatsApp plus SyncBot Inbox.
  6. Enable monitoring for token usage, webhook health, template delivery, and opt-out handling.