Na plataforma da monday.com, é possível enviar um Webhook através das integrações, ou você pode até mesmo criá-los via API. Você pode enviar um Webhook sempre que um evento escolhido ocorrer dentro do seu quadro. Continue lendo para saber mais.
O que é um Webhook?
Webhook (também chamado de callback da web ou API de push HTTP) é uma maneira de um aplicativo fornecer a outros aplicativos informações em tempo real. Um Webhook entrega dados a outros aplicativos assim que uma mudança acontece, o que significa que você recebe os dados imediatamente, ao contrário das APIs típicas, onde você precisaria consultar os dados com muita frequência para obtê-los em tempo real. Isso torna os Webhooks muito mais eficientes tanto para o provedor quanto para o consumidor.
Sempre que você tentar criar um novo Webhook na monday.com, será enviado um desafio JSON para a URL que você fornecer para verificar se você tem controle sobre o endpoint. Continue lendo para descobrir como seu aplicativo deve responder!
Como criar um novo Webhook
No seu quadro, clique no botão Integrações no lado direito da sua tela, em seguida, clique na aba Criar e procure pela integração Webhooks na página de Automação do quadro:
Em seguida, clique no banner de Webhooks e escolha a ação sobre a qual você deseja receber payloads instantâneos:
Após escolher a ação necessária, você precisará especificar a URL. Esta deve ser uma URL que possa retornar o desafio JSON, e será o receptor dos payloads daqui para frente:
E é isso! Assim que essa mudança acontecer, por exemplo, um novo item for adicionado ao seu quadro, seu endpoint receberá um payload sobre a mudança. Você pode encontrar alguns payloads mais abaixo.
Adicione uma descrição para detalhar como sua integração de Webhook está sendo utilizada em seu fluxo de trabalho. Isso permitirá que qualquer usuário que utilize essa integração compreenda melhor qual é o propósito dessa integração e como ela se encaixa no fluxo de trabalho.
Como verificar uma URL de webhook
A URL que você especificou deve ser, claro, controlada pelo seu aplicativo. Nossa plataforma verifica isso enviando um desafio JSON para seu endpoint, e seu aplicativo deve responder com o mesmo desafio.
Enviaremos um corpo POST JSON, contendo um campo “challenge”. Este é um token gerado aleatoriamente que esperamos que você retorne como um campo “challenge” do corpo JSON de resposta a essa solicitação.
Aqui está como o “Challenge” ficará:
{
challenge: “3eZbrw1aBm2rZgRNFdxV2595E9CY3gmdALWMmHkvFXO7tYXAYM8P”
}
O corpo da resposta deve ser um corpo POST JSON idêntico:
{
challenge: “3eZbrw1aBm2rZgRNFdxV2595E9CY3gmdALWMmHkvFXO7tYXAYM8P”
}
Aqui está um exemplo simples de um listener de webhook que imprimirá a saída do webhook e responderá corretamente ao desafio:
app.post("/", function(req, res) { console.log(JSON.stringify(req.body, 0, 2)); res.status(200).send(req.body);})
Como será o formato dos dados do evento?
Todo Webhook enviado para seu endpoint terá um campo de evento em seu corpo. Este campo conterá o payload com os dados do evento.
{
"event": {
"userId": 9603417,
"originalTriggerUuid": null,
"boardId": 1771812698,
"pulseId": 1772099344,
"pulseName": "Webhook create_item",
"groupId": "topics",
"groupName": "Título do Grupo",
"groupColor": "#579bfc",
"isTopGroup": true,
"columnValues": {},
"app": "monday",
"type": "create_pulse",
"triggerTime": "2021-10-11T09:07:28.210Z",
"subscriptionId": 73759690,
"triggerUuid": "b5ed2e17c530f43668de130142445cba"
}
Mudança de valor de coluna (específica ou qualquer mudança de valor de coluna) – payload de exemplo
Isso incluirá o valor anterior, ID da coluna e valor atual.
Dúvidas técnicas? O suporte oficial da monday.com resolve.
Já para levar a produtividade da sua empresa ao próximo nível, conheça os serviços de consultoria e treinamento da Audatia, parceira certificada da monday.com no Brasil. Agende um bate-papo →
