A maior parte dos nossos clientes usa apenas o painel do Br Envio para gerenciar a rotina. Se o time de tecnologia precisa conectar a plataforma ao CRM, ERP, loja virtual ou sistema próprio, oferecemos uma API REST e webhooks com assinatura de segurança. A documentação técnica está em docs.brenvio.com.br.
Use um token Bearer gerado na sua conta (menu Integrações). Com a API você cria ou atualiza contatos e dispara mensagens avulsas de marketing ou transacionais. A resposta é assíncrona: a API responde na hora aceitando o pedido e o coloca na fila de envio — isso não significa que o e-mail já foi entregue.
Cadastre endpoints no painel (Integrações → Webhooks) e receba notificações HTTP quase em tempo real quando eventos importantes acontecem — por exemplo mensagem enviada com sucesso ou falha de entrega, além de atualizações de contato e conclusão de campanha. Todos os eventos vêm com assinatura HMAC para validar a origem; você pode pausar o endpoint ou rotacionar a chave secreta quando precisar.
A API segue as mesmas regras de qualidade do painel. Isso protege a sua reputação e a da plataforma:
Usa a plataforma VTEX? Há aplicativo nativo no Hub — você não precisa montar tudo na API do zero. Veja a integração VTEX para sincronização de clientes e carrinho abandonado.
No painel, em Integrações, gere o token Bearer e guarde com segurança (nunca versione em repositórios públicos).
No mesmo menu, cadastre a URL HTTPS do seu sistema. O painel mostra o segredo uma vez. A validação HMAC está na documentação.
Portal interativo: docs.brenvio.com.br. Guias do painel: ajuda.brenvio.com.br.
Sim. Com um token Bearer gerado na sua conta, você cadastra ou atualiza contatos e pode enviar mensagens avulsas (marketing ou transacional) pela API, consumindo a mesma cota do plano. A documentação fica em docs.brenvio.com.br.
São notificações HTTP que o Br Envio envia para a URL do seu sistema quando certos eventos acontecem (por exemplo, mensagem enviada ou falha). A entrega usa assinatura HMAC para que você possa validar a autenticidade da origem.
Não. A maioria dos clientes usa apenas o painel. A API e os webhooks são recursos para times de tecnologia que precisam automatizar a troca de dados entre o Br Envio e outros sistemas, como um CRM, ERP ou loja virtual.
Sim. Qualquer mensagem avulsa aceita pela API consome a cota de envios do seu ciclo atual (como uma campanha). Diferente disso, apenas o teste manual de envio feito pelo painel (limitado a 1 por minuto) não consome cota.
O nosso portal para desenvolvedores (com OpenAPI interativo) fica em docs.brenvio.com.br. Guias operacionais do painel em linguagem simples ficam em ajuda.brenvio.com.br.