Variáveis de Ambiente

Veja o arquivo de exemplo do env no repositório oficial.

Server

Variável	Valor	Exemplo
SERVER_TYPE	O tipo de servidor (http ou https)	http
SERVER_PORT	Porta em que o servidor será executado	8080
SERVER_URL	O endereço para seu servidor em execução. Esse endereço é utilizado para retornar dados de requisição interna, como links de webhook.	`https://exemplo.evolution-api.com`

Telemetria

Variável	Valor	Exemplo
TELEMETRY	Habilita ou desabilita a telemetria (true ou false)	true
TELEMETRY_URL	URL do servidor de telemetria	`https://telemetry.example.com`

CORS

Variável	Valor	Exemplo
CORS_ORIGIN	As origens permitidas pela API separadas por vírgula (utilize ”*” para aceitar requisições de qualquer origem)	*
CORS_METHODS	Métodos HTTP permitidos separados por vírgula	GET,POST,PUT,DELETE
CORS_CREDENTIALS	Permissão de cookies em requisições (true ou false)	true

Logs

Variável	Valor	Exemplo
LOG_LEVEL	Logs que serão mostrados entre: ERROR, WARN, DEBUG, INFO, LOG, VERBOSE, DARK, WEBHOOKS	ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS
LOG_COLOR	Mostrar ou não cores nos Logs (true ou false)	true
LOG_BAILEYS	Quais logs da Baileys serão mostrados entre: “fatal”, “error”, “warn”, “info”, “debug”, “trace”	error

Instâncias

Variável	Valor	Exemplo
DEL_INSTANCE	Em quantos minutos uma instância será excluída se não conectada. Use “false” para nunca excluir	false

Armazenamento Persistente

Variável	Valor	Exemplo
DATABASE_ENABLED	Se o armazenamento persistente está habilitado (true ou false)	true
DATABASE_PROVIDER	Provedor de banco de dados (postgresql ou mysql)	postgresql
DATABASE_CONNECTION_URI	A URI de conexão do banco de dados	`postgresql://user:pass@localhost:5432/evolution?schema=public`
DATABASE_CONNECTION_CLIENT_NAME	Nome do cliente para a conexão com o banco de dados, usado para separar uma instalação da API de outra que usa o mesmo banco	evolution_exchange

Quais dados serão salvos (true ou false)

Variável	Valor
DATABASE_SAVE_DATA_INSTANCE	Salva dados de instâncias
DATABASE_SAVE_DATA_NEW_MESSAGE	Salva novas mensagens
DATABASE_SAVE_MESSAGE_UPDATE	Salva atualizações de mensagens
DATABASE_SAVE_DATA_CONTACTS	Salva contatos
DATABASE_SAVE_DATA_CHATS	Salva conversas
DATABASE_SAVE_DATA_LABELS	Salva etiquetas
DATABASE_SAVE_DATA_HISTORIC	Salva histórico de eventos

RabbitMQ

Variável	Valor	Exemplo
RABBITMQ_ENABLED	Habilita o RabbitMQ (true ou false)	false
RABBITMQ_URI	URI de conexão do RabbitMQ	`amqp://localhost`
RABBITMQ_EXCHANGE_NAME	Nome do exchange	evolution
RABBITMQ_GLOBAL_ENABLED	Habilita o RabbitMQ de forma global (true ou false)	false

Escolha os eventos que deseja enviar para o RabbitMQ

Variável	Valor	Exemplo
RABBITMQ_EVENTS_APPLICATION_STARTUP	Envia um evento na inicialização do app (true ou false)	false
RABBITMQ_EVENTS_INSTANCE_CREATE	Envia eventos de criação de instância (true ou false)	false
RABBITMQ_EVENTS_INSTANCE_DELETE	Envia eventos de deleção de instância (true ou false)	false
RABBITMQ_EVENTS_QRCODE_UPDATED	Envia eventos de atualização do QR Code (true ou false)	false
RABBITMQ_EVENTS_MESSAGES_SET	Envia eventos de criação de mensagens (recuperação de mensagens) (true ou false)	false
RABBITMQ_EVENTS_MESSAGES_UPSERT	Envia eventos de recebimento de mensagens (true ou false)	false
RABBITMQ_EVENTS_MESSAGES_EDITED	Envia eventos de edição de mensagens (true ou false)	false
RABBITMQ_EVENTS_MESSAGES_UPDATE	Envia eventos de atualização de mensagens (true ou false)	false
RABBITMQ_EVENTS_MESSAGES_DELETE	Envia eventos de deleção de mensagens (true ou false)	false
RABBITMQ_EVENTS_SEND_MESSAGE	Envia eventos de envio de mensagens (true ou false)	false
RABBITMQ_EVENTS_CONTACTS_SET	Envia eventos de criação de contatos (true ou false)	false
RABBITMQ_EVENTS_CONTACTS_UPSERT	Envia eventos de recuperação de contatos (true ou false)	false
RABBITMQ_EVENTS_CONTACTS_UPDATE	Envia eventos de atualização de contatos (true ou false)	false
RABBITMQ_EVENTS_PRESENCE_UPDATE	Envia eventos de atualização de presença (“digitando…” ou “gravando…”) (true ou false)	false
RABBITMQ_EVENTS_CHATS_SET	Envia eventos de criação de conversas (recuperação de conversas) (true ou false)	false
RABBITMQ_EVENTS_CHATS_UPSERT	Envia eventos de criação de conversas (recebimento ou envio de mensagens em novos chats) (true ou false)	false
RABBITMQ_EVENTS_CHATS_UPDATE	Envia eventos de atualização de conversas (true ou false)	false
RABBITMQ_EVENTS_CHATS_DELETE	Envia eventos de deleção de conversas (true ou false)	false
RABBITMQ_EVENTS_GROUPS_UPSERT	Envia eventos de criação de grupos (true ou false)	false
RABBITMQ_EVENTS_GROUP_UPDATE	Envia eventos de atualização de grupos (true ou false)	false
RABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE	Envia eventos de atualização nos participantes de grupos (true ou false)	false
RABBITMQ_EVENTS_CONNECTION_UPDATE	Envia eventos de atualização de conexão (true ou false)	false
RABBITMQ_EVENTS_CALL	Envia eventos de chamadas (true ou false)	false
RABBITMQ_EVENTS_TYPEBOT_START	Envia eventos de início de fluxo do Typebot (true ou false)	false
RABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS	Envia eventos de atualização no status do Typebot (true ou false)	false

SQS

Variável	Valor	Exemplo
SQS_ENABLED	Se o SQS está habilitado (true ou false)	false
SQS_ACCESS_KEY_ID	O ID de chave do SQS	-
SQS_SECRET_ACCESS_KEY	Chave de acesso	-
SQS_ACCOUNT_ID	ID da conta	-
SQS_REGION	Região do SQS	-

WebSocket

Variável	Valor	Exemplo
WEBSOCKET_ENABLED	Habilita o WebSocket (true ou false)	false
WEBSOCKET_GLOBAL_EVENTS	Habilita eventos globais no WebSocket (true ou false)	false

WhatsApp Business API

Variável	Valor	Exemplo
WA_BUSINESS_TOKEN_WEBHOOK	Token usado para validar o webhook no Facebook APP	evolution
WA_BUSINESS_URL	URL da API do WhatsApp Business	`https://graph.facebook.com`
WA_BUSINESS_VERSION	Versão da API do WhatsApp Business	v20.0
WA_BUSINESS_LANGUAGE	Idioma da API do WhatsApp Business	en_US

Webhook Global

Variável	Valor	Exemplo
WEBHOOK_GLOBAL_ENABLED	Se os webhooks estão habilitados globalmente (true ou false)	false
WEBHOOK_GLOBAL_URL	URL que receberá as requisições de webhook	`https://webhook.example.com`
WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS	Ativa webhook por evento, respeitando a URL global e o nome de cada evento (true ou false)	false

Eventos de webhook com valor true ou false

Variável
WEBHOOK_EVENTS_APPLICATION_STARTUP
WEBHOOK_EVENTS_QRCODE_UPDATED
WEBHOOK_EVENTS_MESSAGES_SET
WEBHOOK_EVENTS_MESSAGES_UPSERT
WEBHOOK_EVENTS_MESSAGES_EDITED
WEBHOOK_EVENTS_MESSAGES_UPDATE
WEBHOOK_EVENTS_MESSAGES_DELETE
WEBHOOK_EVENTS_SEND_MESSAGE
WEBHOOK_EVENTS_CONTACTS_SET
WEBHOOK_EVENTS_CONTACTS_UPSERT
WEBHOOK_EVENTS_CONTACTS_UPDATE
WEBHOOK_EVENTS_PRESENCE_UPDATE
WEBHOOK_EVENTS_CHATS_SET
WEBHOOK_EVENTS_CHATS_UPSERT
WEBHOOK_EVENTS_CHATS_UPDATE
WEBHOOK_EVENTS_CHATS_DELETE
WEBHOOK_EVENTS_GROUPS_UPSERT
WEBHOOK_EVENTS_GROUPS_UPDATE
WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE
WEBHOOK_EVENTS_CONNECTION_UPDATE
WEBHOOK_EVENTS_LABELS_EDIT
WEBHOOK_EVENTS_LABELS_ASSOCIATION
WEBHOOK_EVENTS_CALL
WEBHOOK_EVENTS_TYPEBOT_START
WEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS
WEBHOOK_EVENTS_ERRORS
WEBHOOK_EVENTS_ERRORS_WEBHOOK

Configurações de Sessão

Variável	Valor	Exemplo
CONFIG_SESSION_PHONE_CLIENT	Nome que será exibido na conexão do smartphone	Evolution API
CONFIG_SESSION_PHONE_NAME	Nome do navegador (Chrome, Firefox, Edge, Opera, Safari)	Chrome

QR Code

Variável	Valor	Exemplo
QRCODE_LIMIT	Por quanto tempo o QR code durará	30
QRCODE_COLOR	Cor do QR code gerado	#175197

Typebot

Variável	Valor	Exemplo
TYPEBOT_API_VERSION	Versão da API (versão fixa ou latest)	latest

Chatwoot

Variável	Valor	Exemplo
CHATWOOT_ENABLED	Habilita a integração com Chatwoot (true ou false)	false
CHATWOOT_MESSAGE_READ	Marca como lida a última mensagem do cliente no WhatsApp ao enviar uma mensagem no Chatwoot (true ou false)	true
CHATWOOT_MESSAGE_DELETE	Deleta a mensagem no Chatwoot quando deletada no WhatsApp (true ou false)	true
CHATWOOT_IMPORT_DATABASE_CONNECTION_URI	URI de conexão com o banco de dados do Chatwoot para importar mensagens	`postgresql://user:password@host:5432/chatwoot?sslmode=disable`
CHATWOOT_IMPORT_PLACEHOLDER_MEDIA_MESSAGE	Importa as mensagens de mídia como placeholder no Chatwoot (true ou false)	true

OpenAI

Variável	Valor	Exemplo
OPENAI_ENABLED	Habilita a integração com OpenAI (true ou false)	false

Dify

Variável	Valor	Exemplo
DIFY_ENABLED	Habilita a integração com Dify (true ou false)	false

Cache

Variável	Valor	Exemplo
CACHE_REDIS_ENABLED	Habilita o cache Redis (true ou false)	true
CACHE_REDIS_URI	A URI de conexão do Redis	`redis://localhost:6379/6`
CACHE_REDIS_PREFIX_KEY	Prefixo para diferenciar dados de uma instalação para outra usando o mesmo Redis	evolution
CACHE_REDIS_SAVE_INSTANCES	Salva as credenciais de conexão do WhatsApp no Redis (true ou false)	false
CACHE_LOCAL_ENABLED	Habilita o cache local em memória como alternativa ao Redis (true ou false)	false

Amazon S3 / MinIO

Variável	Valor	Exemplo
S3_ENABLED	Habilita o armazenamento no S3 (true ou false)	false
S3_ACCESS_KEY	Chave de acesso do S3	-
S3_SECRET_KEY	Chave secreta do S3	-
S3_BUCKET	Nome do bucket no S3	evolution
S3_PORT	Porta de conexão ao S3	443
S3_ENDPOINT	Endpoint do S3 (ou MinIO)	s3.amazonaws.com
S3_USE_SSL	Usa SSL para conexão ao S3 (true ou false)	true

Autenticação

Variável	Valor	Exemplo
AUTHENTICATION_API_KEY	Chave da API usada para autenticação global	429683C4C977415CAAFCCE10F7D57E11
AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES	Exibe as instâncias no endpoint de fetch (true ou false)	true

Idioma

Variável	Valor	Exemplo
LANGUAGE	Idioma da API	en

Primeiros Passos

Configuração

Integrações

Server

Telemetria

CORS

Logs

Instâncias

Armazenamento Persistente

Quais dados serão salvos (true ou false)

RabbitMQ

Escolha os eventos que deseja enviar para o RabbitMQ

SQS

WebSocket

WhatsApp Business API

Webhook Global

Eventos de webhook com valor true ou false

Configurações de Sessão

QR Code

Typebot

Chatwoot

OpenAI

Dify

Cache

Amazon S3 / MinIO

Autenticação

Idioma

​Server

​Telemetria

​CORS

​Logs

​Instâncias

​Armazenamento Persistente

​Quais dados serão salvos (true ou false)

​RabbitMQ

​Escolha os eventos que deseja enviar para o RabbitMQ

​SQS

​WebSocket

​WhatsApp Business API

​Webhook Global

​Eventos de webhook com valor true ou false

​Configurações de Sessão

​QR Code

​Typebot

​Chatwoot

​OpenAI

​Dify

​Cache

​Amazon S3 / MinIO

​Autenticação

​Idioma

Server

Telemetria

CORS

Logs

Instâncias

Armazenamento Persistente

Quais dados serão salvos (true ou false)

RabbitMQ

Escolha os eventos que deseja enviar para o RabbitMQ

SQS

WebSocket

WhatsApp Business API

Webhook Global

Eventos de webhook com valor true ou false

Configurações de Sessão

QR Code

Typebot

Chatwoot

OpenAI

Dify

Cache

Amazon S3 / MinIO

Autenticação

Idioma