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

# Chatwoot

> Configure a integração Chatwoot e importe dados com o SDK Python

Use `client.chatwoot` para conectar uma instância VZaps ao Chatwoot.

Campos comuns em todas as chamadas:

| Campo            | Tipo     | Obrigatório | Descrição           |
| ---------------- | -------- | ----------- | ------------------- |
| `instance_id`    | `string` | Sim         | ID da instância.    |
| `instance_token` | `string` | Sim         | Token da instância. |

## `client.chatwoot.get(instance_id, instance_token=...)`

Lê a configuração atual, incluindo `webhook_url` e `token_masked` quando aplicável.

```python theme={null}
chatwoot = client.chatwoot.get("VZ...", instance_token="instance-token")
print(chatwoot)
```

**Retorno:** configuracao Chatwoot (`enabled`, `url`, `account_id`, `webhook_url`, `token_masked`, etc.).

## `client.chatwoot.set(...)`

Cria ou atualiza a integração Chatwoot da instância.

```python theme={null}
saved = client.chatwoot.set(
    instance_id="VZ...",
    instance_token="instance-token",
    enabled=True,
    url="https://app.chatwoot.com",
    account_id="1",
    token="chatwoot-api-token",
    name_inbox="WhatsApp VZaps",
    sign_msg=True,
    sign_delimiter="\n",
    number="5511999999999",
    reopen_conversation=True,
    conversation_pending=False,
    import_contacts=True,
    import_messages=True,
    days_limit_import_messages=30,
    auto_create=True,
    organization="Minha empresa",
    logo="",
    ignore_groups=False,
    ignore_jids=[],
)

print(saved)
```

**Retorno:** configuracao salva (inclui `webhook_url` quando gerada).

Campos principais do payload:

| Campo                        | Tipo      | Obrigatório | Descrição                                              |
| ---------------------------- | --------- | ----------- | ------------------------------------------------------ |
| `enabled`                    | `boolean` | Sim         | Habilita ou desabilita a integração.                   |
| `url`                        | `string`  | Sim         | URL base do Chatwoot.                                  |
| `account_id`                 | `string`  | Sim         | ID numérico da conta.                                  |
| `token`                      | `string`  | Sim         | Token da API do Chatwoot.                              |
| `name_inbox`                 | `string`  | Não         | Nome do inbox API.                                     |
| `auto_create`                | `boolean` | Não         | Cria inbox e webhook automaticamente.                  |
| `import_contacts`            | `boolean` | Não         | Importa contatos no fluxo inicial.                     |
| `import_messages`            | `boolean` | Não         | Importa mensagens no fluxo inicial.                    |
| `days_limit_import_messages` | `number`  | Não         | Janela de importação de mensagens em dias. Mínimo `1`. |
| `ignore_groups`              | `boolean` | Não         | Ignora mensagens de grupos.                            |
| `ignore_jids`                | `list`    | Não         | JIDs a ignorar.                                        |

<Tip>
  Copie `webhook_url` da resposta no inbox API do Chatwoot quando `auto_create` não aplicar automaticamente.
</Tip>

## `client.chatwoot.delete(instance_id, instance_token=...)`

Remove a integração Chatwoot da instância.

```python theme={null}
client.chatwoot.delete("VZ...", instance_token="instance-token")
```

**Retorno:** confirmacao de remocao da integracao.

## `client.chatwoot.trigger_import(...)`

Dispara importação manual de contatos, mensagens ou ambos.

Importar contatos:

```python theme={null}
client.chatwoot.trigger_import(
    instance_id="VZ...",
    instance_token="instance-token",
    what="contacts",
)
```

**Retorno:** confirmacao do job de importacao (`contacts`, `messages` ou `all`).

Importar mensagens:

```python theme={null}
client.chatwoot.trigger_import(
    instance_id="VZ...",
    instance_token="instance-token",
    what="messages",
)
```

Importar tudo:

```python theme={null}
client.chatwoot.trigger_import(
    instance_id="VZ...",
    instance_token="instance-token",
    what="all",
)
```

Valores aceitos em `what`: `contacts`, `messages`, `all`.