Hubz API: connect Zalo conversations to your CRM

Hubz API v1 lets your software (CRM, ERP, Odoo, website) work with the Zalo conversations your team handles in Hubz: find customers, read conversations, send messages written by your staff, receive webhooks on new messages and embed the Hubz chat.

What you can do with the Hubz API

• Sync customers: find a customer by phone number or name (GET /v1/contacts) and link a Hubz customer to a record in your software (PUT /v1/contacts/{id}/links).
• Read conversations and messages: get a conversation, its message history and attached files.
• Send messages: send messages written or approved by your staff into an existing conversation. They go through the same queue and limits of the Zalo account as messages staff send by hand.
• Receive events: webhooks on new messages, changed messages and conversation updates, or poll events if your software sits behind NAT.
• Embed Hubz: one conversation's chat, or the whole Hubz app, inside your software.

Concepts

• Zalo account (Account): a Zalo account of your business connected to Hubz.
• Contact (Contact): the person you talk to, which can be linked to a record in your software.
• Conversation (Conversation) and message (Message): a chat between one Zalo account and a customer or a group.
• Event (Event): message.created, message.updated, conversation.updated.

Basics

• Base URL: https://api.hubz.vn. Requests and responses are JSON.
• Authentication with an integration key created by the business owner: see Authentication.
• About 300 requests a minute per key, which may change during the beta: see Rate limits and errors.
• v1 only adds fields, it never changes or removes them; breaking changes go to /v2 and are listed in the Changelog.

Where to start

Follow the Quick start: create a key, make your first request and receive your first webhook. Using Odoo? See the Odoo guide.