Webhooks
Criando seu webhook
Configure uma URL para receber eventos da Elix em tempo real e manter pagamentos e cobranças sincronizados.
A Elix fornece webhooks em tempo real para manter pagamentos, cobranças e outros eventos da sua conta sincronizados com o seu sistema.
O que são os webhooks
Webhooks são notificações enviadas pela Elix quando um evento acontece. Em vez de consultar a API repetidamente, sua aplicação recebe uma requisição POST na URL cadastrada no Painel.
Dessa forma, seu backend pode atualizar o status de uma cobrança, confirmar um recebimento ou iniciar outro processamento assim que a informação estiver disponível.
Prepare seu endpoint
A URL precisa estar acessível publicamente e aceitar requisições HTTP. Recomendamos utilizar HTTPS e responder com um status 2xx quando a notificação for recebida corretamente.
Como cadastrar seu webhook na Elix
Este passo a passo considera que sua conta PJ já está aprovada e que você possui acesso à Área do Cliente.
- 1
Acesse sua conta
Entre na Área do Cliente com o usuário responsável pela integração.
- 2
Abra Minha conta
Abra o menu do usuário no canto superior direito, selecione Minha conta e acesse a área de integrações.
- 3
Gere suas credenciais
Na aba Credenciais API, gere o par de API Key e Secret Key caso sua integração ainda não possua uma credencial ativa. Guarde os valores em um local seguro antes de continuar.
- 4
Abra a aba Webhooks
Ao lado de Credenciais API, selecione Webhooks. O Painel organiza os cadastros por tipo: contas, recebimentos, pagamentos, transferências internas, saldo e taxas.
- 5
Informe a URL e as credenciais
Clique em Novo webhook ou em Cadastrar no tipo desejado. Selecione o tipo, informe a URL pública do seu endpoint e, se necessário, defina a API Key e a Secret Key opcionais utilizadas para proteger as chamadas.
- 6
Crie o webhook
Revise os dados e clique em Criar webhook. O cadastro aparecerá como ativo na lista e poderá ser testado, editado ou excluído pelo próprio Painel.
Boas práticas
- Use uma URL HTTPS pública e dedicada para os eventos da Elix.
- Processe notificações de forma idempotente para evitar atualizações duplicadas.
- Nunca registre a Secret Key em logs nem a exponha no frontend.