Recentemente tenho que trabalhar com várias APIs externas e que usam webhooks para informar suas atividades. Isso quase sempre tem gerado erros na minha API, por conta da documentação desatualizada e payload estranho. Percebo que não tem sido uma tarefa trivial debuggar esse hooks.
Vamos para uma forma interessante e rápida que encontrei para isso usando o postman.
Configurando o Postman
Primeiro você vai precisar gerar uma API Key do postman, algo feito junto das sua configurações da sua conta na parte API Keys.
Ao gerar sua API, você vai usar isso na parte de Authorization da request como o tipo API Key e setar os valores gerados.
Você também vai precisar saber sua collection e workspace para gerar um webhook no postman. Para isso você vai usar outros dois endpoints. um para coletar o id da collection que vamos usar e outro do workspace.
https://api.getpostman.com/collections/
https://api.getpostman.com/workspace/
Para ambos você precisa usar as credenciais do api key.
Gerando o webhook
Para gerar o webhook, vamos criar um chamada usando o método POST no endpoint https://api.getpostman.com/webhooks?workspace= o valor do workspace é o mesmo que pegamos na consulta de workspace.
O body que vamos enviar deve ser o seguinte.
{
"webhook": {
"name": "Nome do webhook",
"collection": {{colection_id}}
}
}
Com esse JSON já temos o retorno da URL que vamos usar.
Monitorando
Quando criamos um webhook no postman, ele cria um item em monitor, assim conseguimos pegar as informações desse hook.
é isso
Fontes e materiais de consulta