Introdução
A API da Wevi permite que sistemas externos (CRMs, automações no Make, n8n, Zapier ou scripts seus) leiam e gravem dados na sua organização sem passar pela interface web.
Tudo é REST, JSON e HTTPS. Sem SDK obrigatório, sem WebSocket, sem GraphQL.
Quando usar a API
- Sincronizar contatos do seu CRM com a Wevi (HubSpot, Pipedrive, planilha): envie cada lead novo pra cá automaticamente, com tags, campos personalizados e o atendente responsável já atribuído.
- Disparar automações quando algo acontece no seu sistema (compra finalizada, abandono de carrinho): chame um webhook nosso pra iniciar uma sequência de mensagens.
- Enviar mensagens WhatsApp programaticamente: notifique status de pedido, confirmações, alertas.
- Descobrir metadados da org: liste campos personalizados, tags e atendentes elegíveis pra carteira sem precisar abrir a UI.
Endpoints disponíveis
| Endpoint | Método | Pra quê |
|---|---|---|
/contacts |
POST | Criar ou atualizar contato (upsert). Aceita campos nativos, custom, tags e dono de carteira. |
/contacts |
GET | Buscar um contato individual por id, email, phone ou cpf. |
/contacts-schema |
GET | Listar campos personalizados, tags, atendentes elegíveis e conexões WhatsApp da org. |
/automation-trigger |
POST | Disparar um fluxo de automação. |
/send-template |
POST | Enviar um template aprovado pelo Meta. |
/send-message |
POST | Enviar texto livre (só dentro da janela de 24h). |
/send-buttons |
POST | Enviar mensagem com até 3 botões de resposta rápida. |
/send-list |
POST | Enviar lista de opções (até 10 itens em seções). |
/send-cta-url |
POST | Enviar mensagem com 1 botão que abre um link externo. |
/send-location-request |
POST | Pedir a localização (GPS) do cliente. |
/send-product |
POST | Enviar card de produto único do catálogo Meta. |
/send-product-list |
POST | Enviar catálogo com até 30 produtos em 10 seções. |
/health |
GET | Ping pra monitoramento. |
URL base: https://api.wevi.chat/functions/v1/
Tipos de autenticação
A API usa a API key (wevi_*), que funciona em todos os endpoints. Veja autenticação pra detalhes.
| Tipo | Pra quê | Onde criar |
|---|---|---|
API key (wevi_*) |
Todos os endpoints da API (contatos, envio de mensagens, etc.) | Conta → Desenvolvedores → API Keys |
Próximos passos
- Autenticação: como gerar e usar cada tipo de token.
- Rate limits: quantas requisições por minuto cada endpoint aceita.
- Códigos de erro: formato padrão dos erros e o que cada um significa.
Em caso de dúvida, abra o chat na central de ajuda.
Próximo
Autenticação