Skip to main content
Connect your business systems to Visito to bring customer conversations, AI assistance, and day-to-day operations into the same workflow. Use the API from your backend, let the AI call your custom tools, and react to changes with webhooks.

What you can build

Channels and conversations

Read connected channels and conversation history, then send replies in existing conversations.Use cases: Build a support inbox, show conversation context inside your CRM, or let your operations team reply from an internal tool.

WhatsApp templates

Create, list, and send approved WhatsApp templates through connected channels.Use cases: Send appointment reminders, order updates, or service notifications from events in your backend, subject to WhatsApp approval and messaging requirements.

AI and human handoffs

Control AI participation, assign operators, inspect handoffs, and return resolved conversations to AI.Use cases: Route an escalated case to a specialist or pause AI while your team or an external system owns the conversation.

Message delivery

Track an accepted send request and the delivery status of its messages.Use cases: Show delivery progress in your application and flag failed notifications for review. A queued request is not confirmation of delivery.

Knowledge

Manage the text, files, and website sources your agent uses to answer questions.Use cases: Publish updated FAQs from your CMS, upload service manuals, or refresh website content after your policies change. Check ingestion status and source activation before relying on the new content.

Custom AI tools

Give your agent access to live data and actions implemented by your own backend.Use cases: Look up an order, check availability, retrieve loyalty points, or create a support ticket during a conversation. Your backend supplies the business logic and permissions.

Commerce

Manage catalog items and read sales for synchronization with your own systems.Use cases: Keep products, services, and add-ons aligned with your catalog, or import sales into fulfillment and accounting workflows.

Sales CRM

Read published pipeline configuration, opportunities, activity, linked contacts, and follow-ups; update opportunity fields or stages.Use cases: Mirror opportunities into your CRM, build a sales review dashboard, or update an existing opportunity after qualification in your system. Follow-ups are available for reading.

Businesses and locations

Read the businesses or operating units configured in your Visito account.Use cases: Map Visito business IDs to locations in your system and use the matching business when configuring scoped catalog items or custom tools.

Reporting

Read messaging summaries, daily metrics, and channel totals for a selected period.Use cases: Build a weekly operations report, compare channel activity, or add messaging trends to your business intelligence dashboard.

Webhooks

Receive signed notifications for new messages, delivery changes, handoffs, and sales opportunity changes.Use cases: Trigger your integration when something changes: open a work item, refresh CRM data, or update delivery progress. Events contain identifiers and metadata; retrieve content through the API.

Combine capabilities into a workflow

When your integration handles replies automatically, enable manual mode before processing inbound events so it coordinates with Visito AI. The conversation control guide explains ownership and delivery tracking.

Choose your starting point

Base URL

All requests must be made from your backend. Do not call the M2M API from browser or mobile client code.

Machine-Readable API Definition

Browse the API Reference for endpoint parameters, request and response schemas, required scopes, and interactive requests. Use these guides for integration workflows and examples. Use the OpenAPI definition as the source for generated clients, runtime validators, and AI coding assistants. The specification covers the current /m2m/v1 endpoints, required scopes, parameters, request bodies, response shapes, and structured errors.
Do not infer endpoints from older examples or client code. If an endpoint is not in the current OpenAPI definition or this Developer Guide, treat it as unavailable.

Core Concepts

  • Tenant: The business account your M2M credential belongs to.
  • Channel: A connected WhatsApp, Instagram, Messenger, or Web Chat destination.
  • Conversation: A thread between an external user and a Visito tenant.
  • M2M credential: A server-side API key with explicit scopes.
  • Idempotency-Key: A required header for send operations so retries do not duplicate work.

Request Pattern

Write operations that create outbound work also require an idempotency key:

Response Model

Outbound sends are asynchronous. When you send a reply or WhatsApp template, Visito returns 202 Accepted with a queued response. Delivery status is processed by Visito’s dispatcher and reflected in conversation history.
202 Accepted means the request was stored and queued. It does not mean the channel provider delivered the message. Store the returned replyId, requestEventId, and correlationId, then read the conversation again to reconcile the message status.

Error Shape

Errors use structured codes and human-readable messages.
error.details is optional. When present, use it for structured recovery information such as missing scopes or retryAfterSeconds.
1

Create an M2M key

Generate a credential from the Visito dashboard with only the scopes your integration needs.
2

List channels

Call GET /m2m/v1/channels and store the channelId for the WhatsApp or Meta channel you want to use.
3

Read conversations

Use GET /m2m/v1/conversations to sync a working set into your CRM or backend.
4

Send safely

Use Idempotency-Key on every send request and store the returned replyId for reconciliation.