> ## Documentation Index
> Fetch the complete documentation index at: https://developers.datafyapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurar Chatwoot

> Conecta o canal a um Chatwoot self-hosted no modo nativo: cria (ou adota) a caixa de entrada no Chatwoot apontando para o proxy da Datafy e passa a repassar as mensagens recebidas para lá. Idempotente: chamar de novo atualiza a URL e o nome.

Conecta o canal a um **Chatwoot self-hosted** no modo nativo. A Datafy cria (ou adota) uma caixa de entrada no seu Chatwoot apontando para o proxy da Datafy e passa a repassar para lá as mensagens recebidas no número. É o mesmo que a tela de Chatwoot do painel faz, agora pela API.

> [!NOTE]
>
> O canal precisa já estar **conectado ao WhatsApp** antes de ligar o Chatwoot. Se ainda não estiver, a resposta é `409`.

## Pré-requisito no seu Chatwoot

O token de acesso (`api_token`) precisa ser de um usuário **administrador**. E o seu Chatwoot precisa ter a variável de ambiente **`WHATSAPP_CLOUD_BASE_URL`** apontando para o proxy da Datafy, com os serviços reiniciados:

```bash theme={null}
WHATSAPP_CLOUD_BASE_URL=https://cloud.datafyapi.com.br/v1
```

Sem isso, o Chatwoot tenta validar a conexão direto na Meta com o token da Datafy e a Meta recusa — a resposta vem como `400` pedindo para configurar essa variável.

## Editar

Chamar de novo atualiza a configuração. Para trocar apenas a URL ou o nome da caixa de entrada, você pode **omitir o `api_token`** — o token guardado é mantido.

## Resposta

| Campo | Descrição |
| - | - |
| `url` | URL do Chatwoot |
| `account_id` | ID da conta no Chatwoot |
| `inbox_id` | ID da caixa de entrada no Chatwoot |
| `inbox_name` | Nome da caixa de entrada |
| `alerta` | Presente só quando o Chatwoot marcou o canal como "conexão expirada". Nesse estado ele descarta as mensagens recebidas; abra a caixa de entrada no Chatwoot e reconecte. |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json PUT /channels/whatsapp/{id}/chatwoot
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp/{id}/chatwoot:
    put:
      summary: Configurar Chatwoot
      description: >-
        Conecta o canal a um Chatwoot self-hosted no modo nativo: cria (ou
        adota) a caixa de entrada no Chatwoot apontando para o proxy da Datafy e
        passa a repassar as mensagens recebidas para lá. Idempotente: chamar de
        novo atualiza a URL e o nome.
      operationId: configurarChatwoot
      parameters:
        - $ref: '#/components/parameters/CanalId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
                - inbox_name
              properties:
                url:
                  type: string
                  example: https://chat.seudominio.com
                  description: URL do seu Chatwoot self-hosted.
                api_token:
                  type: string
                  example: xxxxxxxxxxxxxxxxxxxx
                  description: >-
                    Token de acesso de um usuário do Chatwoot com permissão de
                    administrador. Obrigatório na primeira configuração; ao
                    editar só a URL ou o nome, pode ser omitido para manter o
                    token guardado.
                inbox_name:
                  type: string
                  example: Atendimento
                  description: Nome da caixa de entrada criada no Chatwoot.
            example:
              url: https://chat.seudominio.com
              api_token: xxxxxxxxxxxxxxxxxxxx
              inbox_name: Atendimento
      responses:
        '200':
          description: Chatwoot configurado.
          content:
            application/json:
              example:
                url: https://chat.seudominio.com
                account_id: 1
                inbox_id: 2
                inbox_name: Atendimento
        '400':
          description: Dados inválidos ou Chatwoot inacessível.
          content:
            application/json:
              examples:
                sem_url:
                  summary: URL ausente
                  value:
                    statusCode: 400
                    message: Informe a URL do seu Chatwoot (url)
                sem_token:
                  summary: Token ausente na primeira configuração
                  value:
                    statusCode: 400
                    message: Informe o token de acesso do Chatwoot (api_token)
                inacessivel:
                  summary: URL ou token errado
                  value:
                    statusCode: 400
                    message: >-
                      Não conseguimos acessar seu Chatwoot com esses dados.
                      Confira a URL e o token de acesso.
                base_url:
                  summary: WHATSAPP_CLOUD_BASE_URL não configurada no Chatwoot
                  value:
                    statusCode: 400
                    message: >-
                      Seu Chatwoot não conseguiu validar a conexão. Confirme se
                      a variável WHATSAPP_CLOUD_BASE_URL foi adicionada e se
                      você reiniciou os serviços.
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          $ref: '#/components/responses/CanalNaoEncontrado'
        '409':
          description: O canal ainda não está conectado ao WhatsApp.
          content:
            application/json:
              example:
                statusCode: 409
                message: Conecte o canal ao WhatsApp antes de ligar o Chatwoot.
components:
  parameters:
    CanalId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do canal, retornado em Listar canais e em Criar canal.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
    CanalNaoEncontrado:
      description: Canal inexistente ou de outra conta.
      content:
        application/json:
          example:
            statusCode: 404
            message: Canal não encontrado
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.