Webhooks

Testando Webhooks

Isso permitirá que você verifique se o Fluid envia uma entrega de webhook em resposta a um evento que você espera que acione uma entrega de webhook.

Você também pode testar seu código que lida com entregas de webhook usando seu computador como um servidor local e encaminhando as entregas de webhook para o seu servidor local. Isso permitirá que você desenvolva e depure seu código sem implantá-lo no seu servidor de produção.


Testando a entrega de webhook

Você pode acionar um evento de webhook e verificar se o Fluid enviou uma entrega de webhook.

  • Acione seu webhook. Por exemplo, se você estiver testando um webhook de Ação que está inscrito no evento de criação, crie uma Ação no quadro onde o webhook está configurado.

  • Se você estiver usando um webhook de organização ou repositório, também pode usar a API REST para acionar o evento ping do seu webhook. 

  • Verifique no Fluid se uma entrega de webhook foi enviada.

Se uma entrega de webhook não foi enviada, ou se uma entrega de webhook foi enviada mas o Fluid indica que a entrega falhou, consulte o guia de solução de problemas para ajudar a diagnosticar o problema. Para mais informações, consulte Solução de problemas de webhooks.


Testando o código de webhook localmente

Para testar seu código de webhook localmente no seu computador, você pode usar uma URL de proxy de webhook para encaminhar webhooks do Fluid para o seu computador ou codespace. Você pode usar seu computador como um servidor local para receber esses webhooks encaminhados.

As seções a seguir demonstram como usar o ngrok http://ngrok.com para fornecer uma URL de proxy de webhook e encaminhar webhooks. Outras alternativas como http://smee.io também podem ser usadas.

Para exemplos específicos de código e etapas de teste, consulte  Lidando com entregas de webhook.


Obter uma URL de proxy de webhook

  1. No seu navegador, acesse http://ngrok.com.

  2. Cadastre-se, caso ainda não tenha feito. O cadastro é gratuito

  3. Consulte https://ngrok.com/download para instalar o ngrok.

  4. Em uma janela de cmd, execute ngrok http<porta> onde <porta> é o número da porta em que seu servidor local está escutando.

  5. Acesse o painel local do ngrok em http://localhost:4040 para encontrar as informações da sua URL pública na aba de status.

For IISExpress running a localhost instance, you will need to configure the http-header as part of your ngrok configuration for ngrok to forward correctly. Replace [port] with the port number of your running instance.

ngrok http [port] --host-header="localhost:[port]"



Configurar um webhook para usar a URL de proxy de webhook

Configure seu webhook para usar a URL de proxy de webhook acima. Para mais informações, consulte Como configurar a integração de Webhooks com o Fluid Boards.

Agora, o Fluid enviará entregas de webhook para essa URL.


Iniciar um servidor local

No seu computador, inicie um servidor local. A forma como você faz isso depende de como seu código para receber webhooks está escrito. Para exemplos, consulte Lidando com entregas de webhook

Você deve garantir que seu código possa ser executado localmente. Por exemplo, se seu código depende de variáveis de ambiente no seu servidor em produção, você deve garantir que as variáveis de ambiente também estejam disponíveis no seu servidor local.

Você também pode achar útil adicionar instruções de log para verificar se as etapas do seu código foram executadas conforme o esperado.

Mantenha seu servidor local em execução enquanto testa seu webhook.


Encaminhar webhooks

1. Se você ainda não tem o ngrok instalado, execute o seguinte comando no seu terminal:

choco install ngrok

2. Para receber webhooks encaminhados do ngrok, execute o seguinte comando no seu terminal. Substitua PORT pela porta onde seu servidor local está escutando.

ngrok http PORT

Para o IISExpress executando uma instância localhost, você precisará configurar o http-header como parte da sua configuração do ngrok para que o ngrok encaminhe corretamente. Substitua [port] pelo número da porta da sua instância em execução.
ngrok http [port] --host-header="localhost:[port]"


Agora, quando sua URL de proxy de webhook (URL pública do ngrok encontrada em http://localhost:4040) receber uma entrega de webhook do Fluid, o ngrok encaminhará a entrega de webhook para o seu servidor local.

3. Mantenha isso em execução enquanto testa seu webhook. Quando quiser parar de encaminhar webhooks, pressione Ctrl+C.

Neste ponto, você deve ter tanto o seu servidor local em execução quanto o encaminhamento do ngrok em execução.


Acionar uma entrega de webhook

Acione seu webhook. Por exemplo, se você estiver testando um webhook de repositório que está inscrito no evento de issues, abra uma issue no repositório onde o webhook está configurado.


Verificar entrega

Você pode verificar se o Fluid enviou uma entrega de webhook, se o ngrok recebeu e encaminhou a entrega, e se o seu servidor local processou a entrega de webhook.


Verificar se o Ngrok recebeu sua entrega de webhook

Acesse seu painel do ngrok em http://localhost:4040. Na aba de inspeção, você deve ver um evento que corresponde ao evento que você acionou. Isso indica que o Fluid enviou com sucesso uma entrega de webhook para a URL de payload que você especificou.

Se você não ver sua entrega de webhook no ngrok, verifique se seu webhook está usando sua URL de proxy de webhook (URL do ngrok encontrada na aba de status do seu painel do ngrok http://localhost:4040).


Verificar se o seu servidor local processou a entrega de webhook

Neste ponto, você verificou que o Fluid enviou uma entrega de webhook e que o ngrok encaminhou a entrega para o seu servidor local. Agora, você deve verificar se o seu código processou a entrega de webhook conforme o esperado. A forma como você faz isso depende de como seu código para receber webhooks está escrito. Para exemplos, consulte Lidando com entregas de webhook.

Was this article helpful?