Skip to main content

​
API Synax

Bem-vindo à documentação da API do Synax. Aqui você encontra tudo o que precisa para integrar seu sistema com a plataforma.

​
Base URL

https://api.synax.app.br/functions/v1/api-proxy

​
Autenticação

Todas as requisições usam API Keys. Gere sua chave em Configurações > API no app. 
curl "https://api.synax.app.br/functions/v1/api-proxy/contacts" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui"

​
O que você pode fazer

Contatos

Criar, listar, atualizar e excluir contatos do CRM

Conversas

Consultar conversas do chat e gerenciar status

Mensagens

Consultar histórico de mensagens

Negócios

Gerenciar deals no pipeline de vendas

Campanhas

Acompanhar campanhas de disparo

Webhooks

Receber notificações em tempo real

​
Recursos disponíveis

RecursoEndpointMétodos
Contatos/api-proxy/contactsGET, POST, PATCH, DELETE
Conversas/api-proxy/conversationsGET, PATCH
Mensagens/api-proxy/messagesGET
Negócios/api-proxy/dealsGET, POST, PATCH
Pipelines/api-proxy/pipelinesGET
Estágios/api-proxy/stagesGET
Campanhas/api-proxy/campaignsGET
Disparos/api-proxy/dispatchesGET

​
Início rápido

1

Crie sua API Key

No app, vá em Configurações > API e clique em Nova chave.
2

Faça sua primeira requisição

Liste seus contatos para validar a integração.
3

Configure webhooks

Receba eventos em tempo real via Supabase Realtime.