Quando o módulo Chatwoot não está habilitado no servidor, todos os endpoints do módulo retornam
503 com a mensagem integration gateway not configured.Como funciona
- Você ativa a integração com
POST /api/chatwoot/set/:instance(ou inline, na criação da instância). - A RyzeAPI cria a inbox no Chatwoot e passa a entregar ali as mensagens recebidas no WhatsApp.
- As respostas enviadas pelo agente no Chatwoot voltam para a RyzeAPI e são entregues no WhatsApp.
Endpoints de gerenciamento
Ativar
POST /api/chatwoot/set/:instance, provisiona a integração e cria a inbox.Status / Info
GET /api/chatwoot/list/:instance, retorna o estado atual da integração.Desativar
DELETE /api/chatwoot/delete/:instance, remove a integração (a inbox no Chatwoot é preservada).Ativação inline na criação da instância
A integração pode ser ativada junto com a criação da instância, sem precisar chamarset separadamente. Basta enviar o bloco chatwoot* no body de POST /api/instance/new:
chatwoot retorna com status: "error" e error: "<mensagem>". Você pode então chamar POST /api/chatwoot/set/:instance para corrigir as credenciais sem recriar a instância.
Detectar se o módulo está habilitado
Modelo de dados
O servidor persiste cada integração na tabelachatwoot_integrations. O chatwootApiToken é encriptado at-rest com AES-256-GCM e é retornado em plaintext em GET /api/chatwoot/list/:instance.
| Campo | Descrição |
|---|---|
bridge_integration_id | ID interno da integração. |
chatwoot_base_url | URL da instalação Chatwoot. |
chatwoot_account_id | ID numérico da conta Chatwoot. |
chatwoot_inbox_id / chatwoot_inbox_name | Inbox criada no Chatwoot. |
status | active / paused / error. |
last_error | Última mensagem de erro da integração. |
Próximos passos
Ativar integração
Provisione a integração com
POST /api/chatwoot/set/:instance.Erros do Chatwoot
Tabela de mapeamento dos status HTTP e mensagens da integração.