Getting Started with Partner API

Knowledge Base

Knowledge Base

Getting Started with Partner API

This article will help you understand what your integration can look like and where to start development.

Key definitions
What the Wazzup API offers
Authorization
Integration scenarios
- For Wazzup Label
- For White Label

Key Definitions

End customer — the final user of the Wazzup service. The partner acts and makes API calls on this user's behalf.

End-customer account/Sub-account — a Wazzup account created by the technical partner for their end‑customer.

User — a CRM employee profile (e.g., a sales manager or support agent) who uses the integration to manage deals or handle inquiries.

Channel — a messenger or social media account that can be connected to the CRM via Wazzup.

What the Wazzup API offers

The Wazzup API provides a straightforward way to integrate messaging apps and social networks into your SaaS service. Your users will be able to communicate via messengers directly from within your platform.

Connecting messengers. Your integration can support one or multiple types of channels, including single or multiple numbers. For example, you can connect two WhatsApp accounts and a Viber number for a single client.

Messaging. The API enables communication across a wide range of platforms: Telegram, WhatsApp and WhatsApp Business API (WABA), Viber, and Instagram API.

Automation. Partners operating under the Wazzup Label model can offer their customers auto‑reply features through the Wazzup interface: for first incoming messages, out‑of‑office hours, and missed calls.

Broadcasts. While the Wazzup API does not include built‑in broadcasting tools, you can implement your own broadcast functionality using connected channels such as WhatsApp Business API (WABA).

Authorization

Depending on the method, one of two authorization types is used in the request headers:

1) Basic authorization. Use your Wazzup partner account credentials (email and password) encoded in Base64:

Authorization: Basic base64(email:password)

This type of authorization is required for:

Managing end‑customer accounts,
Retrieving information about your affiliate account,
Working with WABA limits and balances.

2) client_access_token

This token is required for:

Acting on behalf of the end‑customer — connecting channels, sending messages, managing CRM entities (contacts, funnels, deals),
Receiving and processing webhooks.

Integration Scenarios

Below are two basic integration scenarios for Wazzup Label and White Label. In practice, you can use the combination of methods and tools that best fits your customer's needs.

You have two options for handling chats within your service:

Embed the ready‑to‑use Wazzup chat window (iframe) — this gives your users access to all familiar messaging features out of the box;
Build your own chat interface — use individual API methods to work with messages and develop a custom messaging experience.

We recommend using the Wazzup chat interface because:

No need to build or maintain your own messaging UI — you save development effort and avoid ongoing maintenance;
You get new features first — we continuously improve the interface to make it more convenient and valuable. New capabilities are added to the iframe first, and only later become available via individual API methods;
Familiar user experience — the Wazzup chat window looks and feels like a native messenger, so your users can start working with it immediately — no learning curve required;
Mobile app included — your users can stay connected even when they're on the go, thanks to the Wazzup mobile app.

👉 Learn more about Wazzup chats

👉 Learn more about the Wazzup mobile app

In the scenarios described below, you can use either the built‑in Wazzup chat window (iframe) or the individual messaging methods for communication. However, since we recommend using the iframe, all scenarios reference this approach.

If you plan to build your own chat interface, keep in mind that development will take longer than the timelines outlined in these scenarios.

For Wazzup Label

The first four development steps will take approximately two to three days. After that, your customers will be able to connect channels in their own accounts and start messaging directly from the embedded chat window.

What to do	Why it matters
1. Get access to your partner account and `client_id`	Contact your Wazzup manager to obtain your credentials. You'll need your `client_id`, email, and password for the next steps
2. Obtain a token for the end‑customer account	Required to perform actions on behalf of your customer — connecting channels, sending messages, etc.
3. Sync your service's user accounts with Wazzup	Ensures Wazzup has an up‑to‑date list of your users who will be working in Wazzup chats
4. Learn how to open the chat window	Global scope `"scope": "global"` – displays all chats accessible to the user. Place this button prominently for easy access. Card scope `"scope": "card"` - shows chats related to a specific contact (e.g., linked to a deal). Best placed within contact or deal records
5. Sync your CRM contacts with Wazzup	Enables: chats to be shown to the responsible manager, quick navigation to contact cards in your CRM, initiating chats from contact records — even for contacts created before Wazzup integration
6. Sync your CRM deals with Wazzup	Ensures: chats are visible to the manager responsible for the deal, managers can see open and closed deals for a contact, and can quickly jump to the deal card in your CRM
7. Set up the unanswered counter	Alerts managers to unanswered messages. Best placed on the button that opens the global chat window
8. Learn to receive and process webhooks	Enables you to receive new message notifications and use them in your system's alerting
9. Fine‑tune the Deals dropdown	1. Verify that links are correctly passed in `PATCH /v2/contacts` to display a button linking to the contact page in your CRM. 2. Verify that links are correctly passed in `PATCH /v2/deals` to display links to existing deals associated with the contact. 3. Subscribe to webhooks for creating a deal or contact, or learn how to create new deals when the user clicks the "+" in the "Deals" dropdown via an event.

For White Label

The first seven development steps will take a few days to complete. After that, your customers will be able to connect channels in their own accounts and start messaging directly from the embedded chat window.

What to do	Why it matters
1. Get access to your affiliate account and `client_id`	Contact your Wazzup manager to receive your credentials. You'll need your `client_id` , email, and password for the steps that follow
2. Create an account for your customer	This will generate a customer `account_id` , which you'll need to obtain user access tokens
3. Obtain a token for the end‑customer account	This token allows you to perform actions on behalf of the customer — connecting channels, sending messages, and more
4. Sync your service's user accounts with Wazzup	This ensures Wazzup has an up‑to‑date list of the users who will be working in Wazzup chats
5. Learn how to open the chat window	Global scope `"scope": "global"` — displays all chats accessible to the user. Add a button that opens this view — place it prominently, always within easy reach for managers. Card scope `"scope": "card"` — shows chats related to a specific contact (e.g., those linked to a deal). Best placed within contact or deal records, so managers can open relevant conversations directly from the entity they're working on
6. Subscribe to and start processing channel webhooks	At a minimum, you'll need `channel.qr_update` and `channel.status_update` : `channel.qr_update` — required to connect phone‑based channels (e.g., a Telegram number); `channel.status_update` — keeps you informed about changes in channel status
7. Add channel connection capability to your service	Enable customers to connect channels — either via the Wazzup iframe or through dedicated channel management methods
8. Sync your CRM contacts with Wazzup	This ensures that: chats are shown to the manager responsible for each contact; users can quickly navigate to the contact card in your CRM; you can initiate a chat from a contact record — even for contacts that were created in your CRM before integrating with Wazzup
9. Sync your CRM deals with Wazzup	This ensures that: chats are shown to the manager responsible for the deal; managers can see a list of open and closed deals associated with a contact; they can quickly jump to the deal card in your CRM
10. Set up the unanswered counter	This lets managers know when there are unanswered messages waiting. We recommend placing the counter on the button that opens the global chat window
11. Learn to receive and process new message webhooks	This enables you to get real‑time notifications about incoming messages and use them in your system's alerting or notification features
12. Fine‑tune the Deals dropdown	1. Verify contact links – ensure links are correctly passed in `PATCH /v2/contacts` so a button linking to the contact page in your CRM is displayed. 2. Verify deal links – check that links are correctly passed in `PATCH /v2/deals` to display existing deals associated with the contact. 3.Subscribe to webhooks for creating a deal or contact, or learn how to create new deals when the user clicks the "+" in the "Deals" dropdown via an event.