Pular para o conteúdo principal
GET
/
api
/
chatwoot
/
list
/
:instance
Status / info
curl --request GET \
  --url https://api.example.com/api/chatwoot/list/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Retorna o status local da integração Chatwoot e tenta enriquecê-lo com dados live do RyzeIntegrations bridge (best-effort). O chatwootApiToken nunca é exposto nesta resposta.

​
Exemplo

curl -X GET "https://ryzeapi.cloud/api/chatwoot/list/suporte" \
  -H "token: $Token_Account"

​
Resposta de sucesso

200 OK
{
  "instance_name": "suporte",
  "status": "active",
  "bridge_integration_id": "int_xyz789abc",
  "chatwoot_base_url": "https://chatwoot.example.com",
  "chatwoot_account_id": 5,
  "chatwoot_inbox_id": 42,
  "chatwoot_inbox_name": "WhatsApp - Orion",
  "last_error": "",
  "created_at": "2026-04-20T10:15:30Z"
}
CampoDescrição
instance_nameNome da instância.
statusactive / paused / error. Quando o bridge responde, este valor é live.
bridge_integration_idID retornado pelo RyzeIntegrations no momento do set.
chatwoot_base_urlURL da instalação Chatwoot.
chatwoot_account_idID numérico da conta Chatwoot.
chatwoot_inbox_idID do inbox criado pelo bridge (preenchido após o primeiro list que conseguir falar com o bridge).
chatwoot_inbox_nameNome do inbox.
last_errorÚltima mensagem de erro reportada pelo bridge. Vazio quando saudável.
created_atTimestamp RFC 3339 da criação da integração.
O campo chatwootApiToken é serializado com tag json:"-", ele nunca aparece na resposta, mesmo para o TokenAccount da conta dona.

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância (ex.: suporte).

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Comportamento

1

Lê os dados locais

Consulta a tabela chatwoot_integrations. Esta etapa é rápida e sempre funciona.
2

Enriquecimento live (best-effort)

Se o bridge está habilitado, faz GET /v1/integrations/<bridge_integration_id> com timeout de 10s. Em caso de falha de rede, segue com os dados locais.
3

Sobrescreve campos voláteis

Se o bridge respondeu, status e last_error são substituídos pelos valores live.
4

Backfill de inbox_id

Se o bridge devolveu um inbox_id e o local ainda está em 0, atualiza o banco (SetInboxID), útil para casos de eventual consistency logo após o set.
5

404 do bridge é tolerado

Quando o bridge responde 404 para o bridge_integration_id, é tratado como eventual consistency (não é erro): seguimos com os dados locais.

​
Erros

HTTPerror.message
404instance not found
404no chatwoot integration for this instance
503integration gateway not configured (set BRIDGE_URL and BRIDGE_TOKEN)
Se last_error está não-vazio, inspecione a mensagem, geralmente indica que o Chatwoot derrubou a sessão (token rotacionado, inbox removido manualmente, etc.). Reativar com POST /api/chatwoot/set/:instance costuma resolver.

​
Próximo

Reativar / atualizar

Use POST /api/chatwoot/set/:instance para corrigir credenciais ou flags.

Desativar

Remova a integração local + bridge.