# Watx

> Documentation for Watx: one inbox for WhatsApp, Instagram and website chat, with a CRM, automations, flows, forms, AI agents, integrations and a public API.

- [Introduction](https://docs.watx.in/index.md): Watx is a WhatsApp-first customer messaging and CRM platform — one shared inbox for WhatsApp, Instagram and your website, with contacts, automations and AI agents behind it.
- [Quickstart](https://docs.watx.in/getting-started/quickstart.md): Create an account, name your workspace, start the free trial, connect WhatsApp, send your first message and invite a teammate.
- [Core concepts](https://docs.watx.in/getting-started/concepts.md): The vocabulary Watx uses — workspaces, members, contacts, conversations, channels, templates, and the difference between automations, flows and AI agents.
- [Workspaces](https://docs.watx.in/getting-started/workspaces.md): One login can belong to several workspaces. How to switch, how membership is granted, and what happens when you belong to none.
- [Plans and billing](https://docs.watx.in/getting-started/plans-and-billing.md): Starter, Growth and Enterprise; the one 15-day trial per workspace; what counts against your limits; automatic renewal, failed payments, and cancelling.
- [Signing in](https://docs.watx.in/account/sign-in.md): Create an account with email and password or Google, confirm your email, reset a forgotten password, and accept an invitation.
- [Security and privacy](https://docs.watx.in/account/security-and-privacy.md): How your login is protected, what other members of a workspace can see, how connected credentials are stored, and how data-deletion requests are handled.
- [Settings](https://docs.watx.in/settings/overview.md): A map of the settings rail — what belongs to you, what belongs to the workspace, and who can see each section.
- [Members and roles](https://docs.watx.in/settings/members-and-roles.md): The four roles and what each can do, inviting a teammate with a link, changing a role, removing someone, and transferring ownership.
- [Workspace settings](https://docs.watx.in/settings/workspace.md): Fields and tags, canned replies, deals and currency, phone number formatting, and the appearance of the app.
- [Team performance](https://docs.watx.in/contacts/team-performance.md): How much each teammate is handling — replies, conversations, resolutions and first-response time.
- [API keys](https://docs.watx.in/settings/api-keys.md): Create a key for the public REST API, choose its scopes, and revoke it when it is no longer needed.
- [Inbox](https://docs.watx.in/inbox/overview.md): One queue for WhatsApp, Instagram and website chats — how the three panes, the filters and the live updates work.
- [Working a conversation](https://docs.watx.in/inbox/conversations.md): Assign a conversation, change its status, see who else is in it, and use the contact panel beside the thread.
- [Sending messages](https://docs.watx.in/inbox/sending.md): Text, media, voice notes, reactions, quoted replies, templates, product cards and payment links — and what each channel supports.
- [Canned replies](https://docs.watx.in/inbox/canned-replies.md): Save the answers your team types most and drop them into a chat with a slash shortcut.
- [Notifications](https://docs.watx.in/inbox/notifications.md): The in-app notification feed, what raises an entry, and the sound and desktop alerts for new messages.
- [Contacts](https://docs.watx.in/contacts/overview.md): The list, search and filters, bulk actions, CSV import, where contacts come from, and the contact drawer.
- [Fields and tags](https://docs.watx.in/contacts/fields-and-tags.md): The built-in contact fields, the address, custom fields you define yourself, and colour-coded tags.
- [Segments](https://docs.watx.in/contacts/segments.md): Named audiences — an explicit list, or a saved filter that works out its own members — and how they are used.
- [Activity timeline](https://docs.watx.in/contacts/activity-timeline.md): Everything that has happened to one contact — orders, payments, carts, deals, notes, forms, campaigns and messages — in one list.
- [Pipelines and deals](https://docs.watx.in/contacts/pipelines-and-deals.md): Track deals through stages on a drag-and-drop board, with values, owners and the metrics above it.
- [Media library](https://docs.watx.in/contacts/media-library.md): Upload a file once and reuse it in the inbox, template headers, flows and broadcasts.
- [Automations](https://docs.watx.in/automations/overview.md): A trigger plus a sequence of steps that runs without anyone watching — on WhatsApp, Instagram and your website.
- [The canvas editor](https://docs.watx.in/automations/editor.md): Build an automation on a canvas: add steps, wire branches, name each step, and save or activate it.
- [Triggers](https://docs.watx.in/automations/triggers.md): Every event that can start an automation, what it carries, and which ones ignore channel scoping.
- [Steps](https://docs.watx.in/automations/steps.md): Every automation step by category, with its settings and the values it hands to later steps.
- [Variables and expressions](https://docs.watx.in/automations/expressions.md): The token syntax an automation uses to read the contact, the message, a form answer or an earlier step's response — and the filters that shape it.
- [Conditions and branching](https://docs.watx.in/automations/conditions.md): Split an automation on one or more rules, run an A/B test, and pause a run until a duration or a moment.
- [Channels and the 24-hour window](https://docs.watx.in/automations/channels-and-window.md): Scope an automation to a channel, understand which steps each channel supports, and keep a follow-up inside WhatsApp's messaging window.
- [Diagnostics and logs](https://docs.watx.in/automations/diagnostics-and-logs.md): The checks panel before an automation goes live, what the server refuses to activate, and how to read a run afterwards.
- [Templates and Build with AI](https://docs.watx.in/automations/templates-and-ai.md): Start from a ready-made automation, or describe what you want in a sentence and edit the draft.
- [Flows](https://docs.watx.in/flows/overview.md): A visual WhatsApp chatbot: buttons, lists and questions that route a customer to the right answer before a human steps in.
- [The flow editor](https://docs.watx.in/flows/editor.md): Build a WhatsApp flow: the palette, the canvas, the inspector, the entry node, and what has to be true before it can be activated.
- [Node types](https://docs.watx.in/flows/nodes.md): Every node a WhatsApp flow can contain, what it sends or asks, and where it can go next.
- [Waits, hand-offs and runs](https://docs.watx.in/flows/waits-and-runs.md): What happens between messages: parked runs, unmatched replies, timeouts, hand-offs, and the run history.
- [Testing and Build with AI](https://docs.watx.in/flows/testing-and-ai.md): Walk through a flow in a phone preview before anyone else does, and draft one from a sentence.
- [Forms and bookings](https://docs.watx.in/forms/overview.md): Hosted forms that capture leads, feedback and appointments, and route every answer into your contacts and automations.
- [The form builder](https://docs.watx.in/forms/builder.md): Add fields, set what each one does, and publish — the editor's tabs and the canvas that shows exactly what a visitor will see.
- [Field types](https://docs.watx.in/forms/field-types.md): Every field you can put on a form, the settings it takes, the formats it can enforce, and how an answer reaches the contact record.
- [Conditional logic and steps](https://docs.watx.in/forms/conditional-logic.md): Show a field only when an earlier answer matches, and split a long form into steps with a progress bar.
- [Appearance](https://docs.watx.in/forms/appearance.md): Colour scheme, accent, header style and corners for a hosted form — set in the builder's Design panel and previewed on the canvas.
- [Booking forms](https://docs.watx.in/forms/bookings.md): Turn a form into a booking page: availability, slot length, buffers, notice, group capacity, and the link a customer uses to move or cancel.
- [Sharing a form](https://docs.watx.in/forms/sharing.md): The public link, a QR code, the embed snippet, sending a form into a chat from an automation, and using one in the website widget.
- [Submissions](https://docs.watx.in/forms/submissions.md): Reading and exporting what a form has collected, how an answer reaches the contact record, and how a submission starts an automation.
- [AI agents](https://docs.watx.in/ai-agents/overview.md): What an agent does, how several of them share one workspace, and the limits it works inside.
- [Create an agent](https://docs.watx.in/ai-agents/create.md): Start blank or from a role, name it, and understand the plan limit before you switch it on.
- [Persona, voice and behaviour](https://docs.watx.in/ai-agents/persona-and-behaviour.md): Who the agent is, what it must never say, how it sounds, when it replies and what it does when it cannot help.
- [Knowledge](https://docs.watx.in/ai-agents/knowledge.md): Give the agent your policies, prices and pages to answer from — uploads, page crawling, indexing status and per-agent selection.
- [Skills](https://docs.watx.in/ai-agents/skills.md): Every skill an agent can be given, what each one unlocks, which need an integration, and the settings each takes.
- [Custom API actions](https://docs.watx.in/ai-agents/custom-actions.md): Let an agent call your own API — defining the endpoint, parameters and headers, testing it, and choosing which agents may use it.
- [Routing](https://docs.watx.in/ai-agents/routing.md): Which agent answers a conversation: channels, the order of the list, stickiness, and what happens when nothing covers a channel.
- [Test mode and the playground](https://docs.watx.in/ai-agents/testing.md): Try an agent in the studio drawer, limit it to your own numbers, or use it to draft replies a human sends.
- [Credits and your own key](https://docs.watx.in/ai-agents/credits-and-byok.md): Run agents on built-in AI credits or on your own OpenAI, Anthropic or Gemini key — how each bills, what a credit costs and how top-ups work.
- [Why is my agent silent?](https://docs.watx.in/ai-agents/readiness.md): The readiness checklist in the studio, and every reason an agent can decline to answer a message — in the order they are checked.
- [Integrations](https://docs.watx.in/integrations/overview.md): The directory of everything Watx can talk to — stores, payments, sales documents, Google, Zapier and n8n — and what each card's status means.
- [Shopify](https://docs.watx.in/integrations/shopify.md): Connect a Shopify store so orders, abandoned carts and your catalogue arrive in Watx — by installing the Watx app, or by pasting an Admin API token.
- [WooCommerce](https://docs.watx.in/integrations/woocommerce.md): Connect a WooCommerce store with REST API keys, then create the webhooks by hand in WordPress so orders and products reach Watx.
- [The store console](https://docs.watx.in/integrations/store-console.md): One page per connected store: health and webhooks, orders, carts and their recovery rules, the catalogue, the messages you send, and cash on delivery.
- [Cash on delivery confirmation](https://docs.watx.in/integrations/cash-on-delivery.md): Ask a cash-on-delivery customer to confirm on WhatsApp before you ship, tag or cancel the order at your store, and auto-cancel the ones nobody answers.
- [Razorpay payments](https://docs.watx.in/integrations/razorpay.md): Collect money from your own customers through your own Razorpay account — payment links from the inbox, automations, flows and AI agents.
- [Sales documents](https://docs.watx.in/integrations/sales-documents.md): Issue invoices, GST bills, quotations, receipts and delivery challans to your own customers — no payment gateway and no store required.
- [Creating and sending a document](https://docs.watx.in/integrations/sales-documents-sending.md): The four-step create dialog, the counter-first customer picker, the real-PDF preview, and how the document reaches WhatsApp as a template with the PDF attached.
- [Document design](https://docs.watx.in/integrations/sales-documents-design.md): Choose how your invoices look — a predefined template, or the layout, accent colour, density, paper size and optional blocks one by one, beside a live PDF preview.
- [Google](https://docs.watx.in/integrations/google.md): Gmail, Calendar, Meet, Sheets, Contacts, Docs and Tasks through one small script you deploy in your own Google account.
- [Google actions](https://docs.watx.in/integrations/google-actions.md): Every action the Apps Script bridge can run — Gmail, Calendar, Sheets, Contacts, Docs and Tasks — with its fields, its outputs, and what an AI agent is allowed to use.
- [Zapier](https://docs.watx.in/integrations/zapier.md): Trigger Zaps when contacts, conversations and messages arrive — paste a Catch Hook URL from Zapier and pick the events it should fire on.
- [n8n](https://docs.watx.in/integrations/n8n.md): Trigger n8n workflows when contacts, conversations and messages arrive — cloud or self-hosted, using the Production URL of a Webhook node.
- [Other services](https://docs.watx.in/integrations/other-services.md): Slack, Notion, Airtable, HubSpot and anything else with an API — added to an automation as an HTTP request step with the URL, method and body already filled in.
- [WhatsApp delivery](https://docs.watx.in/troubleshooting/whatsapp.md): Why a WhatsApp message did not send, why a template was refused, why nothing is arriving, and what to do about each.
- [Instagram](https://docs.watx.in/troubleshooting/instagram.md): Why Instagram DMs or comments are not arriving, why a private reply is refused, what happens to comments deleted in the app, and why a funnel produced nothing.
- [Automations and agents](https://docs.watx.in/troubleshooting/automations-and-agents.md): Why an automation did not fire, why a step was skipped without an error, why a variable came out blank, and why an AI agent stayed silent or answered wrongly.
- [Integrations](https://docs.watx.in/troubleshooting/integrations.md): Store webhooks that deliver nothing, carts that are never recovered, payment links that reach nobody, documents with dashes in them, and Google or Zapier setups that test fine and never fire.
- [FAQ](https://docs.watx.in/troubleshooting/faq.md): Short answers to the questions people ask most — plans and the trial, workspaces and roles, channels, templates, AI, data and the API — each with a link to the page that explains it.
- [WhatsApp](https://docs.watx.in/whatsapp/overview.md): What the WhatsApp channel gives you, what Meta requires before you can use it, and where each part of it lives in Watx.
- [Connect your number](https://docs.watx.in/whatsapp/connect.md): Run Meta's Embedded Signup from inside Watx, register your number, and confirm that messages are actually arriving.
- [Channel settings](https://docs.watx.in/whatsapp/settings.md): The WhatsApp connection screen: status banners, the connected card, diagnostics, reconnecting and resetting.
- [The 24-hour window](https://docs.watx.in/whatsapp/messaging-window.md): WhatsApp's customer service window: what opens it, what closes it, what can still be sent afterwards, and how Watx enforces it everywhere.
- [Message templates](https://docs.watx.in/whatsapp/templates.md): Build a template, submit it to Meta, track its status, and supply the values a send needs — headers, variables, buttons and carousel cards.
- [Template library and packs](https://docs.watx.in/whatsapp/template-library.md): Start from a pre-built template instead of a blank editor, and submit a whole group of them to Meta at once.
- [Broadcasts](https://docs.watx.in/whatsapp/broadcasts.md): Send an approved template to many contacts at once: audiences, exclusions, per-recipient variables, delivery status and re-targeting.
- [Campaign schedules](https://docs.watx.in/whatsapp/campaigns.md): Record when a broadcast or a retargeting campaign should run, once or on a repeating pattern.
- [Catalog and orders](https://docs.watx.in/whatsapp/catalog-and-orders.md): Keep a product catalogue in sync with Meta Commerce, send products as cards in a chat, and work the orders customers place from them.
- [WhatsApp Flows](https://docs.watx.in/whatsapp/whatsapp-flows.md): Meta's native in-app forms — booking, surveys, lead capture — created, validated, previewed and published from Watx.
- [Click-to-WhatsApp](https://docs.watx.in/whatsapp/click-to-whatsapp.md): Record the ads that open a WhatsApp chat, and track clicks and conversations against each one.
- [Analytics](https://docs.watx.in/whatsapp/analytics.md): Volume, delivery and read rates, response times, broadcast and template performance, orders and ad clicks — over a date range you choose.
- [Messaging limits and quality](https://docs.watx.in/whatsapp/limits-and-quality.md): Meta's messaging tiers and quality rating, where Watx shows them, and what the usage meter does and does not count.
- [Instagram](https://docs.watx.in/instagram/overview.md): Instagram DMs, story replies and comments on your posts, in the same inbox as WhatsApp — and the platform rules that make the channel behave differently.
- [Connect Instagram](https://docs.watx.in/instagram/connect.md): What your Instagram account needs before you start, how the Business Login connection works, and what to do when access expires.
- [Posts and automation](https://docs.watx.in/instagram/posts.md): The posts grid: how much of your account answers comments on its own, automating one post or many, and moderating a post without leaving it.
- [Comments](https://docs.watx.in/instagram/comments.md): The comment triage desk — filters, keyboard shortcuts, public replies, private DMs, hiding and deleting, and what happens when a comment is deleted on Instagram.
- [Comment funnels](https://docs.watx.in/instagram/comment-funnels.md): Somebody comments on a post and gets the link in their DMs — the six-step editor, the ready-made templates, and the results each funnel produced.
- [DM agents](https://docs.watx.in/instagram/dm-agents.md): What answers an Instagram DM when nobody on your team has yet — the order the engines are consulted in, and the Instagram rules that change how an agent behaves.
- [Intents](https://docs.watx.in/instagram/intents.md): Keyword rules that route an Instagram DM to the right response, which rules reach Instagram at all, and how comments are handled instead.
- [Settings and analytics](https://docs.watx.in/instagram/settings-and-analytics.md): The Instagram channel settings page — subscribed events, messaging rules and disconnecting — plus what the Instagram analytics overview reports.
- [Website chat](https://docs.watx.in/website/overview.md): A chat widget for your own site, feeding the same inbox as WhatsApp and Instagram — what it does, how a visitor becomes a contact, and what the channel cannot do.
- [Install the widget](https://docs.watx.in/website/install.md): Allow your domain, paste the snippet into your site, and the channel goes live on the first visitor load.
- [Widget settings](https://docs.watx.in/website/settings.md): Colour, position, launcher, wording, AI replies and branding — every setting on the Web Widget page, with a live preview of the real widget.
- [Behaviour](https://docs.watx.in/website/behaviour.md): What the widget does: the pre-chat screen, your business hours, and what happens to a visitor who arrives when you are away.
- [Sessions and analytics](https://docs.watx.in/website/sessions-and-analytics.md): Where your website chats came from — the sessions list with its sources and landing pages, and the analytics overview for the channel.
- [API introduction](https://docs.watx.in/api/introduction.md): Drive your Watx workspace from your own code — send WhatsApp messages, manage contacts and segments, read conversations, launch broadcasts and subscribe to events.
- [Authentication](https://docs.watx.in/api/authentication.md): Create an API key in Settings, send it as a bearer token, and grant only the scopes the integration needs.
- [Requests and responses](https://docs.watx.in/api/requests-and-responses.md): The JSON envelope, the error codes, cursor pagination, rate limits and what is safe to retry.
- [Webhooks](https://docs.watx.in/api/webhooks.md): Register an https endpoint and Watx posts a signed JSON event to it when a message arrives, a status changes, a conversation opens or a contact is created.
- [Postman collection](https://docs.watx.in/api/postman.md): Import every Watx API request into Postman with one file, set your key, and start calling.
- [Who am I](https://docs.watx.in/api-reference/account/who-am-i.md): Returns the workspace the API key belongs to and the scopes it carries.
- [Send a message](https://docs.watx.in/api-reference/messages/send-a-message.md): Sends a WhatsApp message to a phone number. You pass a number, not an internal id: the endpoint finds or creates the contact and the WhatsApp conversation, then sends.
- [List contacts](https://docs.watx.in/api-reference/contacts/list-contacts.md): Lists contacts, newest first, with cursor pagination.
- [Create a contact](https://docs.watx.in/api-reference/contacts/create-a-contact.md): Creates a contact, or returns the existing one with the same phone number. A new contact answers `201`; a match answers `200`. The phone number is stored in E.164 form.
- [Get a contact](https://docs.watx.in/api-reference/contacts/get-a-contact.md): Returns one contact. A contact belonging to another workspace answers `404`.
- [Update a contact](https://docs.watx.in/api-reference/contacts/update-a-contact.md): Updates only the fields present in the body. `name`, `email` and `company` accept a string or `null`; anything else is a `400`. Sending `tags` replaces the contact's tags with exactly that list, creating any tag name the workspace does not have yet.
- [List segments](https://docs.watx.in/api-reference/segments/list-segments.md): Lists every segment in the workspace, ordered by name. This list is not paginated and carries no `member_count`: resolving a dynamic segment reads the whole contact list, so the count is only returned by `GET /segments/{id}`.
- [Create a segment](https://docs.watx.in/api-reference/segments/create-a-segment.md): Creates a segment. `kind` is `static` (an explicit membership list) or `dynamic` (a saved filter, recomputed on every read) and **cannot be changed afterwards** — to switch, delete the segment and create a new one. A `filter` is stored only for a dynamic segment.
- [Get a segment](https://docs.watx.in/api-reference/segments/get-a-segment.md): Returns one segment, including `member_count`. For a dynamic segment the count is computed from its filter at read time.
- [Update a segment](https://docs.watx.in/api-reference/segments/update-a-segment.md): Updates the fields present in the body. `kind` is immutable and is ignored here; sending `filter` for a static segment is a `400`.
- [Delete a segment](https://docs.watx.in/api-reference/segments/delete-a-segment.md): Deletes the segment and its membership rows. The contacts themselves are untouched.
- [List a segment's contacts](https://docs.watx.in/api-reference/segments/list-a-segments-contacts.md): Returns the people in a segment — the stored list for a static segment, the result of the filter for a dynamic one. This is the only correct way to turn a segment into contacts.
- [Add contacts to a segment](https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment.md): Adds contacts to a **static** segment. A dynamic segment answers `400` — its membership comes from its filter.
- [Remove contacts from a segment](https://docs.watx.in/api-reference/segments/remove-contacts-from-a-segment.md): Removes contacts from a static segment. The contact ids go in the request body, as they do when adding. `removed` counts the rows actually deleted.
- [List conversations](https://docs.watx.in/api-reference/conversations/list-conversations.md): Lists conversations, newest first, with cursor pagination. Each row embeds its contact and that contact's tags.
- [Get a conversation](https://docs.watx.in/api-reference/conversations/get-a-conversation.md): Returns one conversation with its contact. A conversation belonging to another workspace answers `404`.
- [List a conversation's messages](https://docs.watx.in/api-reference/conversations/list-a-conversations-messages.md): Lists the messages in one conversation, newest first, with cursor pagination. The conversation is checked against your workspace first — another workspace's conversation answers `404`, never an empty list.
- [Launch a broadcast](https://docs.watx.in/api-reference/broadcasts/launch-a-broadcast.md): Queues a template broadcast to a list of phone numbers. Every recipient is written to the database and handed to the send queue before the call returns, so the `202` survives a restart. Poll `GET /broadcasts/{id}` for progress.
- [Get a broadcast](https://docs.watx.in/api-reference/broadcasts/get-a-broadcast.md): Returns a broadcast with its live counters. `status` moves `queued` to `sending` to `sent` (or `failed`), while `delivered_count` and `read_count` keep climbing as WhatsApp reports back.
- [List webhook endpoints](https://docs.watx.in/api-reference/webhooks/list-webhook-endpoints.md): Lists every webhook endpoint in the workspace, newest first, including endpoints connected from the Zapier and n8n pages (`provider` says which). The signing secret is never returned.
- [Register a webhook endpoint](https://docs.watx.in/api-reference/webhooks/register-a-webhook-endpoint.md): Registers an endpoint and subscribes it to one or more events. The `url` must be `https://` and must resolve to a public address.
- [Get a webhook endpoint](https://docs.watx.in/api-reference/webhooks/get-a-webhook-endpoint.md): Returns one endpoint. The secret is not included.
- [Update a webhook endpoint](https://docs.watx.in/api-reference/webhooks/update-a-webhook-endpoint.md): Changes the `url`, the subscribed `events`, or whether the endpoint is active. Setting `is_active` to `true` also resets the consecutive failure counter, which is how you bring back an endpoint that was disabled automatically.
- [Delete a webhook endpoint](https://docs.watx.in/api-reference/webhooks/delete-a-webhook-endpoint.md): Removes the endpoint. Deliveries stop immediately. Deleting an endpoint whose `provider` is `zapier` or `n8n` disconnects that integration.

## OpenAPI Specs

- [openapi](/openapi.yaml)