Esta é uma funcionalidade destinada para usuários com conhecimentos técnicos avançados, voltada especialmente para profissionais de tecnologia, e envolve o uso de outras ferramentas para se obter algum resultado.
Webhook (também conhecido como retorno de chamada web ou HTTP) é uma forma de receber informações de forma passiva de outra aplicação quando um evento acontece. É uma maneira prática de abastecer outras aplicações com informações em tempo real.
Na Ummense, temos dois tipos de WebHooks:
Webhook de Saída: Pode ser configurado por fluxo e o evento é qualquer ação que altere o estado de um card vinculado ao mesmo, quando esse evento ocorre, um pacote com os dados do card que foi alterado é enviado à URL configurada para receber essa informação.
Webhook de Entrada: Também pode ser configurado por fluxo e serve para o oposto do Webhook de Saída, ou seja, para receber um conjunto de dados vindo de fora da plataforma.
Os dois tipos podem ser configurados de forma personalizada para cada fluxo dentro da Ummense. Enquanto o Webhook de Saída tem uma URL apenas, é possível configurar mais de uma URL para Webhooks de Entrada.
Esses dados podem ser utilizados de diversas formas, como a configuração de Dashboards personalizados, notificações especiais, backup de dados e alimentação de outros sistemas, receber uma demanda e criar cards em algum fluxo específico.
Um dos principais usos é para montar uma dashboard personalizada em um software como o Power BI ou similar, para isso é necessário tratar os dados recebidos para que fiquem de acordo com as necessidades da regra de negócio da empresa, normalmente esses dados tratados podem ser salvos em uma base intermediária que servirá como fonte para o Power BI.
Algumas ferramentas conhecidas que podem auxiliar nesse ecossistema e servir de endpoint para o webhook: Zapier e n8n. O formato enviado e recebido, por padrão, é JSON.
Se você já tem uma URL de destino para receber as informações do webhook, você pode configurar esta integração seguindo os seguintes passos:
1 – Escolha e abra o fluxo a ser integrado
O webhook é configurado por fluxo, pois sabemos que fluxos diferentes podem ter intenções diferentes na análise de dados para estatísticas. A configuração por fluxo também minimiza riscos de vazamento de informações confidenciais por usuários desavisados.
2 – Abra as configurações do fluxo clicando em "configurações" ao lado do título do fluxo.
Nesta tela você terá várias possibilidades de configuração do fluxo.
3. Na área de Webhook de saída, insira a URL de destino para envio dos dados em tempo real
Por questões de segurança contra vazamento de dados, somente são aceitas URLs com o protocolo HTTPS.
4. Ative o webhook e clique em “Salvar e Testar”
A Ummense tentará se comunicar com a sua URL de destino enviando um pacote de teste, ocorrendo algum problema, aparecerá uma mensagem de erro, e você precisará verificar a sua URL.
Um modelo de requisição pode ser encontrado em: https://ummen.se/webhookexample.
As opções disponíveis para ativar o envio desse Webhook de Saída no fluxo são:
Toda chamada advinda da Ummense contará com dois elementos de segurança no cabeçalho que poderão ser utilizados para validar a informação recebida.
A presença desse item de cabeçalho na requisição é uma garantia de que a chamada está vindo da Ummense e o valor será Webhook Call
Para verificar a integridade das informações enviadas pelo Webhook, a Ummense gera uma assinatura calculada com o conteúdo do pacote a ser enviado e a chave é disponibilizada ao salvar o Webhook, e para sua comodidade basta clicar no ícone para copiar.
Quando seu webhook estiver corretamente configurado, a cada alteração do card, como alteração de coluna, equipe, status ou tags, entre outras, serão enviadas as atualizações para o endpoint informado.
Os dados enviados são dados não tratados, pois a razão de existir desta funcionalidade é justamente para dar a liberdade para empresas com necessidades específicas de configurarem e tratarem seus dados da forma como quiserem, para os fins desejados.
Caso a sua empresa necessite de um dado que nosso webhook não está enviando, informe-nos pelo nosso canal de sugestões com o máximo de detalhes possível para que nosso time possa avaliar e implementar, se for possível.
Conheça os diferenciais da plataforma e descubra maneiras práticas para organizar e agilizar o trabalho de toda a equipe.
.png)
