Os webhooks são uma funcionalidade que facilita a comunicação entre dois sistemas, permitindo que sistemas externos sejam notificados de forma imediata e automática quando uma ação ocorrer na plataforma.
Um exemplo muito simples é quando um boleto é pago pelo cliente. Quando é feito o pagamento, o banco envia essa informação para a Kobana. Após configurar o webhook, cada vez que essa ação ocorrer e o banco nos enviar a confirmação, o seu sistema também recebe essa notificação.
Abaixo, vamos mostrar como configurar o Webhook pela interface da Kobana.
Você também pode fazer a configuração do Webhook por API. Confira a nossa documentação e saiba mais!
Como configurar o Webhook na Kobana?
Existem diversos webhooks que podem ser configurados na plataforma. Acima, usamos o exemplo do pagamento de um boleto, mas você pode registrar um webhook para cada evento, como um boleto criado, cancelado, excluído, vencido e diversos outros. Isso se aplica também para todas as outras operações na Kobana, como pagamentos, Pix e extrato.
Confira a lista de todos os eventos que podem gerar configurações de webhook na Kobana!
Para cadastrar um novo webhook pela interface acesse a sua conta da Kobana e clique em Integrações > API Kobana > Webhooks. Caso você já tenha webhooks criados, eles serão exibidos aqui. Clique no botão para Cadastrar Novo Webhook.
Para cadastrar, comece dando um nome para o webhook, para identificá-lo. Você também precisa escolher uma URL que será o endereço de requisição, ou seja, onde serão enviadas as notificações.
Em seguida, você também precisa escolher qual é o evento que irá disparar o webhook. No nosso exemplo de um boleto, você pode escolher o evento Boleto criado como na imagem abaixo, que vai avisar sempre que o boleto for criado na plataforma.
Outra opção, também destacada abaixo, é criar um webhook para Todos os eventos de boleto. Assim, tudo que ocorrer com um boleto será informado automaticamente. Essa opção também se aplica às outras funcionalidades da Kobana.
Continue preenchendo as informações pedidas abaixo. Por definição, o tipo da requisição é em formato json, com limite de 10 envios simultâneos. Por questão de segurança, verificamos se o certificado SSL está habilitado por padrão. Você também pode escolher se o webhook dispara os eventos das suas subcontas, ou apenas na conta principal.
Após clicar no botão Salvar Webhook você verá a sua chave secreta, necessária para configurar o webhook. Salve-a em um local seguro, pois ela será apresentada apenas uma vez.
Após criar o webhook, você pode acessar o menu Integrações > API Kobana > Log de Webhooks, para ver o histórico de todos os envios.