Greenbubble Documentation

User guides Product setup · messaging · Developer API

Learn Greenbubble by task

Guides for connecting channels and messaging. For live API testing, use Integration Tools — not this search page alone.

Guides (this site): /docs
Live API + Try it: /integration_tools
REST host: api.greenbubble.io

Start with Quick start Open live Try it Where API docs live

Connect WhatsApp

Pick Cloud API (WABA) or Scan Device, then finish setup.

Reply in the inbox

Open Unibox, answer customers, and handle the 24-hour window.

Developer API quickstart

Get an API key and send your first request. Use Integration Tools for Try it.

Quick start

From a new workspace to a working conversation in one checklist.

Get started

What Greenbubble is and how to get your first channel working.

Platform overview A plain-language map of workspaces, channels, the shared inbox, automations, templates, and campaigns. Quick start From a new workspace to a working conversation in a short, ordered checklist.

Workspaces and account

Create, switch, and manage workspaces and your account.

Workspace isolation What data stays separate between workspaces and how API key scoping works. Workspace setup Create, switch, edit, and transfer ownership of workspaces.

Connect channels

WhatsApp Cloud API, Scan Device, Telegram, Facebook, and Instagram.

Cloud API vs Scan Device Two ways to connect WhatsApp. Pick the right one before you start. Connect WABA Step-by-step setup for WhatsApp Cloud API (WABA) via Embedded Signup. QR Scan Device Connect WhatsApp by scanning a QR code from your phone. Fast setup with fewer requirements.

Inbox and messaging

Reply in the shared inbox, use Message Logs, and manage conversations.

Send messages Reply to customers in the Unibox with text, media, and interactive messages.

Automations

Build automated flows with triggers, nodes, conditions, and actions.

Automation overview Learn the basics of the visual automation builder and how to create effective flows. Automation triggers Set up entry points that start your automation flows.

Catalogs, commerce, and orders

Create catalogs, manage products, set up a storefront, and handle orders.

Catalogs Set up product catalogs connected to Meta and manage inventory.

Integrations and Developer API

API keys, REST API, webhooks, MCP, and Google integrations.

API Keys Manage integration API keys. Requires plan feature `rest_api`. Middleware: authenticate -> requireSubscription -> requirePlanFeature('rest_api'). API quickstart Get your API key and send your first API request in minutes. Appointments Appointment bookings and availability. Authentication (session) JWT session auth used by the app. External integrators should prefer API keys instead of scraped session tokens. Automation / Bot Flows Tenant automation REST surface under /api/automation. See DEVELOPER_DOCUMENTATION.md section 7 for builder specs. Broadcast Campaigns Bulk template campaigns via /api/v2/campaigns (Cloud API). Also aliased at /api/campaigns. Campaigns - Insights & Recurring Campaign analytics and recurring scheduling. Chatbots AI chatbot knowledge bases. Contacts Create and list contacts via /api/v2/contacts (also aliased at /api/contacts). Contacts - Extended Contact stats, funnels, segmentation, and exports. Currencies Multi-currency settings. Import Jobs Contact import job tracking. Languages Localization / translations. Message Bots Keyword auto-reply bots (requires auto_replies feature). Message Status Message delivery/read status. Message Templates Create Meta message templates (Cloud API / WABA) via /api/v2/templates/create. List/manage via /api/template (also aliased at /api/v2/templates). Notifications In-app notifications. Quick Replies Saved replies for agents. Reply Materials Reusable media/documents for replies. Segments Contact segmentation (static/dynamic groups). Sequences Drip / campaign sequences. Short Links Trackable short links. Subscription (tenant) Tenant self-service subscription under /api/subscription. Tags & Custom Fields - Extended Additional tag/custom-field management. Tags, Segments & Custom Fields Tenant CRM helpers for organizing contacts. Taxes Tax configuration. Teams Agent teams. Templates - Meta Sync Meta-side template sync and publishing. Tenant MCP Streamable HTTP JSON-RPC 2.0. Endpoint: POST https://mcp.greenbubble.io/mcp. Health: GET https://mcp.greenbubble.io/healthz. Auth: x-api-key (tenant key). WABA Configuration Per-WABA settings. Webhooks Inbound webhooks. WhatsApp webhook is POST /webhook/whatsapp with Meta x-hub-signature-256 verification; GET is used for Meta verification challenge. WhatsApp (legacy v1) Legacy unversioned /api/whatsapp surface (unified Cloud API + Scan Device). WhatsApp - Connections & Meta Unified Cloud API + Scan Device connection, meta, and chat management. WhatsApp v2 - Groups (Scan Device) List joined groups and send into them with a connected Scan Device sender (QR session). Requires capabilities.group_messaging. WhatsApp v2 - Messages Public API v2 WhatsApp surface under /api/v2/whatsapp/*. List sender_id values, then send text / media / templates / reactions. Full URL = base + path. For outbound delivery use POST /api/v2/whatsapp/ Working Hours Business working hours per WABA. Workspaces Multi-workspace management.

Billing, security, and compliance

Plans, billing, profile security, consent, and data privacy.

Billing Change plans, update payment methods, and view invoices.

Troubleshooting

Fix connection and delivery problems across all channels.

Troubleshooting Common issues with WhatsApp connections, message delivery, and how to resolve them.

How to use the platform