Menu

Concepts

Migrating from Chatwoot

Concept and endpoint equivalents for Chatwoot integrators.

If you already integrate with Chatwoot, the ConverZap API will feel familiar: conversations, messages, notes, labels, agents, teams and canned responses work the same way. The main differences:

Concepts

ChatwootConverZap
/api/v1/accounts/{account_id}/.../v1/... (the account comes from the key)
api_access_token (user token, no scopes)Authorization: Bearer czk_live_… with scopes
inboxchannel = WhatsApp number (/v1/channels, id = phone_number_id)
many conversations per contactone conversation per contact and number
status open / pending / snoozed / resolvedopen / snoozed / resolved; the bot "pending" becomes awaiting_human: true
message_type 0/1/2direction: inbound / outbound + author (contact, user, ai_agent, phone, campaign…)
private: truenotes at /conversations/{id}/notes
Unix timestampsISO 8601 everywhere
page with fixed sizescursor (limit, cursor)
mixed error shapesRFC 9457 with a stable code

Equivalent endpoints (read)

ChatwootConverZap
GET /conversations?status=&assignee_type=&inbox_id=&labels[]=GET /v1/conversations?status=&assignee=&channel=&label= (assignee: me, unassigned, assigned or id)
GET /conversations/metaGET /v1/conversations/counts
GET /conversations/{id}/messagesGET /v1/conversations/{id}/messages
GET /contacts · /contacts/searchGET /v1/contacts?q= · GET /v1/contacts/by-phone/{phone}
GET /labelsGET /v1/labels
GET /custom_attribute_definitionsGET /v1/custom-fields (contact only)
GET /agents · /teams · /inboxesGET /v1/users · /v1/teams · /v1/channels
GET /canned_responsesGET /v1/canned-responses
GET /inboxes/{id}/message_templatesGET /v1/templates
GET /api/v2/reports/summaryGET /v1/reports/inbox (with the previous period)

What doesn't exist here

Conversation priority, conversation custom attributes (use contact fields), team assigned to a conversation (in ConverZap teams are linked to numbers and round-robin), typing indicators and contact_inboxes (the E.164 phone is enough).

Sending messages, notes and conversation actions come in the next (write) phase.