Skip to main content
Use a URL base https://api.wegly.com.br e uma chave de integração no header Authorization: Bearer <chave>. As rotas públicas de integração começam com /integrations/external. A seção Rotas da API contém os parâmetros, corpos de requisição, permissões e schemas de resposta por operação. A especificação OpenAPI é a referência para gerar clientes e importar a API em ferramentas de integração.

Requisições e respostas

Envie corpos JSON com Content-Type: application/json. Uploads de arquivos e mensagens com mídia usam multipart/form-data, conforme a operação. Nesse caso, deixe seu cliente HTTP gerar o Content-Type com o boundary. As listagens de registros usam skip e take e normalmente retornam { "total": 0, "records": [] }. Filtros e valores padrão variam por recurso. Algumas consultas de chats usam cursor ou paginação por página; siga o contrato específico da rota. POST normalmente retorna 201, e consultas, atualizações e exclusões normalmente retornam 200. O corpo de sucesso varia: pode ser o registro completo, um resultado resumido ou { "success": true }. Não presuma que o retorno da criação seja igual ao da consulta de detalhes. URLs de arquivos e avatares podem ser assinadas e temporárias. Armazene o ID do recurso e consulte a API novamente quando precisar de uma URL atualizada.

Erros

Erros podem conter statusCode, message e error. Em erros de validação, message pode ser uma lista. Ao repetir uma criação de lead, siga as regras de idempotência do guia de leads.

Acompanhar alterações

Configure webhooks de saída para receber eventos de leads, oportunidades, chats e outros recursos. O corpo do webhook tem um envelope próprio e pode diferir do retorno HTTP da operação que gerou o evento.