Skip to main content

​
What you will find here

This documentation covers the VZaps public endpoints for creating instances, billing, session, webhook, messaging, users, groups, contacts, queues, and integrations (TypeBot, Chatwoot).

Start here

See the base URL, authentication headers, and the minimum flow to create and connect an instance.

​
Main areas

Authentication

Learn when to use Authorization, X-Client-Token, and X-Instance-Token.

First-time flow

Follow the recommended steps to create, subscribe, connect, and operate your instance.

API reference

Browse every public endpoint with example requests and responses.

​
Integrations

TypeBot

Automatic conversational flows on WhatsApp: triggers, priority, and sessions.

Chatwoot

Omnichannel support: link the instance WhatsApp to a Chatwoot inbox (bidirectional).

​
Scope

  • Instances and billing: create instance, list, start subscription, resume subscription, cancel.
  • Other API groups: session, webhook, messages, users, groups, contacts, queues, TypeBot, and Chatwoot.
  • Authentication: real rules for how to use the public API headers.
The production base URL for this documentation is https://api.vzaps.com, for example https://api.vzaps.com/instances/{id}/session/qr.

​
Before you integrate

  • Use a valid JWT for instance and billing endpoints.
  • Store X-Client-Token and the instance token from creation securely.
  • For other instance endpoints, use JWT or X-Instance-Token + X-Client-Token, depending on your flow.