Documentation

Last updated: June 5, 2026

Complete guide for setting up SyncBridge — from creating your first chatbot to deploying it on any website, training your AI, and integrating third-party tools.

1. Creating a Chatbot

Chatbots are the core of SyncBridge. Each chatbot has its own identity, knowledge base, and deployment settings. You can create multiple chatbots depending on your plan.

Plan limits

Free / Starter: 1 chatbot
Pro: Up to 3 chatbots
Enterprise: Unlimited chatbots

How to create a chatbot

  1. Go to Dashboard → Bot Deployment.
  2. Click "New Chatbot" (top right).
  3. Enter a Chatbot Name (required) e.g. "Customer Support Bot".
  4. Optionally add a Description and assign a Folder for organisation.
  5. Click "Create". Your new chatbot appears as a deployment card.

The first chatbot you create is automatically set as the default bot. The default bot's knowledge base can be shared across other bots (see Knowledge Base section).

Per-chatbot settings

Click the Settings icon on any deployment card to access four configuration tabs:

System Prompt: Override the global AI prompt for this bot only. Also set a Company Name used by the Google Calendar integration.
Quick Actions: (Pro) Add up to 6 clickable suggestion chips shown to visitors at chat start. Drag to reorder. Display style: Default, Pill, or Body.
Page Rules: Restrict the widget to specific URLs (e.g. https://yoursite.com/support) or exclude pages (e.g. https://yoursite.com/admin/*). Use * as a wildcard.
Data Collection: Choose which visitor fields to collect — Name, Email, Phone (Pro), Company (Pro), Job Title (Pro) — and mark each as required or optional. Enable email forwarding to receive a notification for every new chat.

2. Embed on Any Website

The SyncBridge widget works on any website — HTML, React, Next.js, Webflow, Wix, Squarespace, Shopify, or any other platform. Paste a single script tag before the closing </body> tag.

1. Get your Bot ID

  1. Go to Dashboard → Bot Deployment.
  2. Find your chatbot card. The Bot ID is shown on the card (click the copy icon).

2. Add the embed script

Paste this snippet into your HTML before the closing </body> tag, replacing YOUR_BOT_ID with your actual Bot ID:

<!-- SyncBridge AI Chatbot -->
<script>
  (function(w,d,s){
    w.SyncBridgeConfig = { botId: 'YOUR_BOT_ID' };
    var f = d.getElementsByTagName(s)[0];
    var j = d.createElement(s);
    j.async = true;
    j.src = 'https://yymapabjhmtbbteeddja.supabase.co/storage/v1/object/public/cdn/widget.js';
    f.parentNode.insertBefore(j, f);
  })(window, document, 'script');
</script>

Platform-specific guides

Webflow / Squarespace / Wix: Paste into the site-wide custom code section (usually Site Settings &rarr; Custom Code &rarr; Footer).
Shopify: Add to theme.liquid before </body> via Online Store &rarr; Themes &rarr; Edit Code.
Next.js / React: Use a <Script> component with strategy="afterInteractive" or paste in _document.js / index.html.
Google Tag Manager: Create a Custom HTML tag, paste the script, and trigger on All Pages.

Widget appearance, colours, position, and behaviour are all controlled from Dashboard → Widget Design — no code changes required after the initial embed.

3. WordPress Plugin

For WordPress sites, SyncBridge provides a dedicated plugin that syncs your chatbot settings automatically — no manual script editing required. The plugin connects via Platform Sync using your Bot ID and Agent Service Key.

Install & connect

  1. In your SyncBridge dashboard, go to Bot Deployment → WordPress Plugin and click "Download WordPress Plugin (.zip)".
  2. In your WordPress admin, go to Plugins → Add New → Upload Plugin. Select the ZIP file and click "Install Now".
  3. Click "Activate Plugin". A SyncBridge AI Chatbot menu item will appear in the WordPress sidebar.
  4. Go to SyncBridge AI Chatbot → Settings → Platform Sync.
  5. Copy your Bot ID from the SyncBridge dashboard (Bot Deployment card) and paste it into the Bot ID field.
  6. Copy your Agent Service Key from the same deployment card and paste it into the Agent Service Key field.
  7. Click "Connect". The plugin will verify the credentials and sync your widget settings.
The Agent Service Key is shared across all bots in your workspace. If you regenerate it, all connected WordPress sites will need to be reconnected. The key is partially masked in the dashboard — click the copy icon to get the full value.

WordPress manual embed (alternative)

If you prefer to embed the script manually (e.g. via a page builder like Elementor or Divi), add this to your theme's functions.php:

// Paste at the bottom of Appearance → Theme File Editor → functions.php
add_action('wp_footer', function() {
  echo '<script>(function(w,d,s){';
  echo 'w.SyncBridgeConfig={botId:"YOUR_BOT_ID"};';
  echo 'var f=d.getElementsByTagName(s)[0],j=d.createElement(s);';
  echo 'j.async=true;';
  echo 'j.src="https://yymapabjhmtbbteeddja.supabase.co/storage/v1/object/public/cdn/widget.js";';
  echo 'f.parentNode.insertBefore(j,f);})(window,document,"script");</script>';
});

4. Designing Your Widget

Go to Dashboard → Widget Design to customise how the chat widget looks and behaves. Changes are reflected in the live preview on screen — click "Save Design" to publish them.

Text & Branding tab

Bot Name: The display name shown in the chat header.
Welcome Message: First message shown when the chat window opens. Supports emoji.
Input Placeholder: Hint text inside the message input box.
Popup Message: Toggle on to show a teaser message above the widget button on page load. Set how many seconds (1–60) it stays visible.
Chatbot Logo: Upload a PNG/JPG/SVG/WebP (max 5 MB, recommended 720x720 px) or paste an image URL. Control the size (16–200 px) and where it appears: widget button only, chat window only, or both.
Show Branding: (Pro) Toggle off to hide the "Powered by SyncBridge" footer. You can replace it with a custom label.
Lead Magnet: (Pro) Automatically deliver a URL, promo code, or text snippet to visitors. Choose a trigger: on interest, after email captured, after booking, or always.

Design tab

Primary / Accent colour: Main theme colour — used for the widget button and header.
AI Bubble / AI Bubble Text: Background and text colour for bot messages.
Agent Bubble / Text: Background and text colour for human agent messages.
User Bubble / Text: Background and text colour for visitor messages.
Quick Palettes: 8 preset swatches that apply a colour to both Primary and AI Bubble in one click.
Corner Radius: Slider from 0 (sharp) to 28 px (fully rounded) for the chat bubble corners.

Position tab

Widget Position: Bottom Right, Bottom Left, Side Right, or Side Left.
Widget Bottom Offset: Distance from the bottom of the screen for bottom positions (8–200 px).
Widget Vertical Position: Vertical position as a percentage for side positions (10–90%).
Chat Window Offset: Distance between the widget button and the chat window (8–200 px).

5. Knowledge Base & AI Training

Go to Dashboard → AI Knowledge to train your chatbot. The AI answers questions based on what you add here. There are four ways to add knowledge — you can use all of them together.

System Prompt

At the top of the page, you can set a global System Prompt — the AI's core instructions and personality. The default is: "You are a helpful customer support assistant. Be concise, friendly, and accurate." Click "Save Prompt" after editing.

When knowledge entries exist, the AI answers only from those entries. The system prompt sets the tone and handling style.

Adding knowledge — 4 methods

Click "Train AI" (top right) to open the training modal. Choose a tab:

Manual Text
  1. Select the Manual Text tab.
  2. Enter a Title (required) and optional Category (e.g. "FAQs", "Billing").
  3. Paste or type your content in the Content area.
  4. Toggle Enabled on and click "Save Entry".
Website URL — single page
  1. Select the Website URL tab.
  2. Enter the full page URL (e.g. https://yoursite.com/about).
  3. Optionally set a Title and Category.
  4. Click "Crawl & Train". SyncBridge fetches and extracts the page text (up to 50,000 characters).
  5. The entry is saved and deduplicated — re-crawling the same URL updates the existing entry.
Import from Site — full crawl (Pro)
  1. Select the Import from Site tab.
  2. Enter your site's root URL (e.g. https://yoursite.com).
  3. Optionally set a Category to apply to all crawled pages.
  4. Click "Import All Content". SyncBridge follows internal links and crawls up to 500 pages.
  5. A progress bar shows: X saved · Y updated · Z skipped. Click "Stop" to halt early.
Upload File
  1. Select the Upload File tab.
  2. Drag & drop or browse for a file. Supported formats: PDF, DOCX, XLSX, CSV, TXT, MD, PNG, JPG (max 20 MB).
  3. Title auto-fills from the filename — edit if needed. Set a Category (default: "Documents").
  4. Click "Process & Train". PDF and image files use AI text extraction.

Managing entries

  • Each entry shows its source type (manual, url, file, crawl), character count, category, and an enable/disable toggle.
  • Edit any entry by clicking the edit icon — this reopens the training modal pre-filled.
  • Delete an entry with the trash icon (confirmation required).
  • Use the search bar to filter by title or category.
  • Export all entries as CSV via the Export button. Re-import with the Import button — duplicate entries by URL are updated, not duplicated.

Auto-sync (Pro)

Enable "Auto-Train on Website Content" (right side of page) to automatically crawl and sync your website every 7 days. Enter your site URL and click "Sync Now" for an immediate crawl. The last and next sync times are displayed.

Shared knowledge (multi-bot)

If you have multiple chatbots, each bot can have its own knowledge base, or toggle "Use default bot's knowledge" to inherit all entries from the default bot — useful for product bots that share the same FAQs.

6. Team Management

Go to Dashboard → Team to invite agents, organise departments, and create custom permission roles. Team features require a Pro plan (a 7-day free trial is available at signup).

Adding an agent

  1. Click "Add an Agent".
  2. Enter the agent's Name and Email.
  3. Select a Permission role: Admin, Chat Agent, Analyst, or a custom role.
  4. Assign the agent to one or more Departments.
  5. If you have multiple chatbots, select which Deployments the agent can access.
  6. Click "Add Agent". A temporary password is generated — copy and share it securely. The agent should change it after first login.

Built-in roles

Admin: Full unrestricted access to all features and settings.
Chat Agent: Can view and respond to assigned conversations. Access to Inbox and Leads only.
Analyst: Read-only access to Analytics. Cannot respond to conversations or change settings.

Custom roles

Click "Create a new role" in the Roles tab to build a role with fine-grained permissions. For each area (Dashboard, Inbox, Leads, Bookings, Analytics, Bot Deployment, Widget Design, AI Knowledge, Team, Referrals, Account, Billing) choose: Able to edit, Read only, or No access.

Departments

Departments group agents so conversations can be routed to the right team automatically. A General department is created by default as a catch-all. To add a department:

  1. Go to the Departments tab.
  2. Click "Add new department" and enter a name.
  3. Add agents to the department from the agent chip input.
  4. Click "Save".

Operating hours

Set global agent availability hours from the Agents tab (owner row → "Edit" next to "Global schedule"). Individual agents can override global hours with a custom schedule.

Two-factor authentication (2FA)

The workspace owner can enable 2FA from the Agents tab. Click "Enable 2FA", scan the QR code with an authenticator app (Google Authenticator, Authy, etc.), and enter the 6-digit code to activate.

7. Referrals

The SyncBridge referral programme lets you earn discounts by inviting others to the platform. Available to Starter, Pro, and Enterprise plan subscribers.

How it works

  1. Go to Dashboard → Referrals to find your unique invite link.
  2. Share the link with colleagues, clients, or your audience.
  3. When someone signs up through your link and subscribes to a paid plan, both of you receive a discount — applied automatically at the next billing cycle.
  4. Track your referrals in the Referral History table — see who joined, their subscription status, and when your discount will be applied.

Sharing your link

  • Your invite link is in the format: https://www.sync-bridge.app/register?ref=YOURCODE
  • Use the "Copy" button for a one-click copy, or "Share via Email" to open a pre-filled email draft.
  • The Referral History table shows: invitee email, join date, subscription status, and your reward status.

Reward status

Subscribed: The referred user has an active paid subscription — your discount is pending.
Registered: The referred user signed up but has not yet subscribed to a paid plan.
X% off next bill: Your discount is queued and will be applied at the next billing cycle.
Applied: The discount has already been credited to your account.

8. Integrations

Connect third-party services from Dashboard → Settings → Integrations. Most integrations use one-click OAuth. For platforms that require super-admin credentials (Google, Zoom, Calendly, Facebook), the workspace owner or super admin must first configure the app credentials in Super Admin → Settings → Integrations.

Calendar & Booking

Google Meet / Google Calendar

Requires OAuth credentials configured by the super admin (Google Cloud Console → APIs & Services → OAuth 2.0 Client ID). Required scopes: calendar and calendar.events. Redirect URI: .../functions/v1/google-oauth-callback.

Users connect via Settings → Integrations → Google Meet → one-click "Connect" button.

Zoom

Requires a Zoom General App with meeting:write:meeting scope. Redirect URI: .../functions/v1/zoom-oauth-callback. Credentials set in Super Admin Settings.

Users connect via Settings → Integrations → Zoom → "Connect".

Calendly

Requires a Calendly OAuth app. Redirect URI: .../functions/v1/calendly-oauth-callback. Credentials set in Super Admin Settings.

Users connect via Settings → Integrations → Calendly, then paste their Calendly scheduling URL into the integration settings to enable AI-powered booking.

Messaging Channels

Facebook Page & Messenger
  1. Super admin configures the Meta App ID & Secret in SA Settings → Integrations → Facebook App.
  2. In Meta Developer Portal → your app → Messenger → Settings → Webhooks, subscribe to: messages, messaging_postbacks, message_deliveries, feed.
  3. Set callback URL: .../functions/v1/facebook-webhook with the verify token from SA Settings.
  4. Users connect via Settings → Integrations → Facebook → "Connect with Facebook".
Instagram

Requires an Instagram Professional account linked to your connected Facebook Page. Connect Facebook first — Instagram is detected automatically when the linked account is present.

Twitter / X

Create an app in the X Developer Portal with OAuth 2.0 and Direct Message read/write permissions. Connect via Settings → Integrations → Twitter / X.

WhatsApp Business

Add WhatsApp to your Meta App. Set webhook URL to .../functions/v1/facebook-webhook and subscribe to the messages field. Enter the Phone Number ID and Business Account ID in Settings → Integrations → WhatsApp.

Slack

Create a Slack App with Incoming Webhooks enabled. Paste the webhook URL into Settings → Integrations → Slack to receive lead and booking notifications.

Microsoft Teams

In Teams, create an Incoming Webhook connector for your target channel. Paste the URL into Settings → Integrations → Microsoft Teams.

Email (SMTP)

Configure your SMTP server (host, port, username, password) in Settings → Integrations → Email. Supports port 587 (STARTTLS) and 465 (SSL). Credentials are AES-256 encrypted at rest.

Advanced Integrations

Salesforce

Create a Salesforce Connected App with the api and refresh_token OAuth scopes. Connect via Settings → Integrations → Salesforce. Captured leads are pushed into your CRM pipeline automatically.

Zapier

In Zapier, create a Zap with Webhooks by Zapier → Catch Hook as the trigger. Paste the webhook URL into Settings → Integrations → Zapier. Choose which events to forward: lead.created, conversation.started, conversation.resolved, booking.created, message.received.

WooCommerce

In WP Admin → WooCommerce → Settings → Advanced → REST API, generate a Read key. Enter your store URL plus the Consumer Key and Secret in Settings → Integrations → WooCommerce. The AI can then answer real-time order and product queries.

9. Outgoing Webhooks

Available on Pro and Enterprise plans.

SyncBridge POSTs a signed JSON payload to any HTTPS URL you configure when a platform event occurs. Go to Settings → Integrations → Webhooks & API, then click "+ Add Webhook". Enter a name, your endpoint URL, select which events to subscribe to, and copy the Signing Secret shown in the modal.

Trigger events

Lead captured: A visitor submitted their contact details through the chatbot.
New conversation: A new chat session was initiated.
Visitor message: A new inbound message arrived from a visitor.
Agent handoff: A conversation was handed off to a human agent.
Booking made: An appointment was booked via the AI chatbot.

Example payload — Lead captured

POST https://your-endpoint.com/webhook
Content-Type: application/json
X-SyncBridge-Signature: sha256=<hmac>

{
  "event": "lead_captured",
  "timestamp": "2026-06-05T14:22:00Z",
  "account_id": "acc_xxxxxxxxxxxx",
  "data": {
    "id": "lead_xxxxxxxxxxxx",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "phone": "+1-555-0100",
    "conversation_id": "conv_xxxxxxxxxxxx"
  }
}

Signature verification

Every webhook POST includes an X-SyncBridge-Signature header. Verify it using the Signing Secret shown when you create or edit a webhook:

// Node.js example
const crypto = require('crypto')

function verify(secret, rawBody, signatureHeader) {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(rawBody)
    .digest('hex')
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signatureHeader)
  )
}

10. REST API

Available on Pro and Enterprise plans.

The SyncBridge REST API lets you read and manage your account data programmatically. Find your API key under Settings → Integrations → Webhooks & API.

Base URL: https://api.sync-bridge.app/v1
Auth header: Authorization: Bearer YOUR_API_KEY
Format: All request and response bodies are JSON
Rate limit: 120 requests per minute per API key

Endpoints

GET /conversations: List conversations. Params: ?status=open|resolved&limit=50&offset=0
GET /conversations/:id: Retrieve a conversation with its messages.
PATCH /conversations/:id: Update status: open | resolved | pending.
GET /conversations/:id/messages: List all messages in a conversation.
POST /conversations/:id/messages: Send an agent message into a conversation.
GET /leads: List captured leads. Params: ?from=ISO_DATE&to=ISO_DATE&limit=50
GET /leads/:id: Retrieve a single lead.
DELETE /leads/:id: Delete a lead record.
GET /bookings: List bookings. Params: ?from=ISO_DATE&to=ISO_DATE
GET /bookings/:id: Retrieve a booking.

Example — send a message

POST https://api.sync-bridge.app/v1/conversations/conv_xxxx/messages
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "role": "agent",
  "content": "Hi Jane, looking into your order now.",
  "sender_name": "Support Team"
}

// 201 Response
{
  "id": "msg_xxxxxxxxxxxx",
  "conversation_id": "conv_xxxx",
  "role": "agent",
  "content": "Hi Jane, looking into your order now.",
  "created_at": "2026-06-05T14:25:00Z"
}

Error codes

400: Bad Request — missing or invalid parameters.
401: Unauthorized — API key missing, expired, or invalid.
403: Forbidden — API key lacks permission for this resource.
404: Not Found — resource does not exist.
429: Too Many Requests — rate limit exceeded. Retry after the Retry-After header value.
500: Internal Server Error — contact support if this persists.

11. Developer Support

For integration help, API access, webhook issues, or anything else — reach out to the SyncBridge team:

SyncBridge — Xoryo Technologies

info@xoryotech.com

https://www.sync-bridge.app