Início rápido — Flow

Quatro passos para a primeira integração funcionar.

1. Crie uma API key

No Flow CRM: Integrações → Acesso à API → Gerenciar chaves. Escolha os scopes necessários, por exemplo:

contacts:write
satisfaction:write
mcp:read

Copie o token flow_live_… na hora — ele só aparece uma vez. Guarde em um cofre de segredos.

2. Descubra o workspace

export FLOW_BASE_URL="https://api-sandbox.connectvets.com.br/flow/v1"
export TOKEN="flow_live_<cole_aqui>"

curl -sS "$FLOW_BASE_URL/external/me" \
  -H "Authorization: Bearer $TOKEN"

A resposta inclui workspace_id. Guarde-o para as demais rotas (ou resolva dinamicamente com o mesmo GET).

3. Upsert de contato

export WORKSPACE_ID="<uuid>"

curl -sS -X PUT "$FLOW_BASE_URL/external/workspaces/$WORKSPACE_ID/contacts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"external_id":"erp-1","document":"12345678901","name":"João","phone":"+5511987654321"}'

4. Pesquisa, webhooks ou MCP

Pesquisa: POST …/satisfaction-surveys
Webhooks: configure em Integrações → Webhooks (guia)
Agentes de IA: MCP

Importante: não use a URL do front-end (CRM) nas integrações. Use o gateway (/flow/v1). Workspace com billing inativo bloqueia a API (403).

Flow API Autenticação

Começar

Workspaces

Contatos

Pesquisa de satisfação

Eventos

Inteligência artificial

Referência

Início rápido

Início rápido — Flow

1. Crie uma API key

2. Descubra o workspace

3. Upsert de contato

4. Pesquisa, webhooks ou MCP

​Início rápido — Flow

​1. Crie uma API key

​2. Descubra o workspace

​3. Upsert de contato

​4. Pesquisa, webhooks ou MCP

Início rápido — Flow

1. Crie uma API key

2. Descubra o workspace

3. Upsert de contato

4. Pesquisa, webhooks ou MCP