Usando Webhooks com o Automatizador de Fluxo de Trabalho

Modificado em Fri, 31 Mar 2023 na (o) 03:56 PM

Planos : Starter | Growth | Pro | Enterprise

O que é um Webhook?

Um Webhook é um "callback" para um aplicativo ou serviço web que é acionado quando um evento específico ocorre. Quando uma atualização, mudança ou ação específica ocorre, os Webhooks podem ser usados para enviar dados para um aplicativo externo.

O Automatizador de Fluxo de Trabalho pode ser usado para criar fluxos de trabalho que acionam um Webhook quando um evento específico ocorre.

O que você pode fazer com uma chamada de Webhook?

Usando o Automatizador, você pode criar fluxos de trabalho que disparam ações específicas quando um evento ocorre em um ticket. Usando o Automatizador, você pode atualizar, modificar, enviar notificações e executar ações dentro do Freshservice. Por exemplo, você pode atualizar as prioridades do ticket, enviar e-mails de escalonamento, etc.

Os Webhooks são úteis quando você deseja acionar uma ação em um aplicativo ou ferramenta externa. Aqui estão alguns cenários de exemplo em que você pode querer usar Webhooks:

O que você quer fazer	Condições a serem observadas	O que o Webhook deve chamar
Enviar uma mensagem SMS quando o cliente responder ao ticket	O cliente responde ao ticket (ou adiciona um comentário)	Enviar o conteúdo do comentário para uma ferramenta SMS de terceiros
Atualizar o inventário quando uma solicitação de devolução de produto é atualizada	A categoria do ticket (um campo personalizado) é atualizada para "Devolução de produto"	Atualizar informações do produto no inventário da loja
Sincronizar o status das solicitações de recurso com a ferramenta interna de gerenciamento de produtos	O status é atualizado para tickets do tipo "Solicitação de recurso"	Atualizar a ferramenta de gerenciamento de produtos com as informações do ticket
Disparar alarmes sonoros e sirenes quando uma avaliação de satisfação do cliente ruim é recebida	O feedback do cliente é recebido e a avaliação é "Não bom"	Personalizar uma lâmpada inteligente (como esta ou esta) e uma placa de som de sirene para serem disparadas por este Webhook

Como configurar uma solicitação de webhook com o Automator:

Vamos considerar o seguinte caso de uso:

Criar uma mudança automaticamente sempre que um ticket for uma solicitação de mudança.

Crie um novo fluxo de trabalho usando o Workflow Automator. Arraste e solte os Eventos e Condições que devem acionar o webhook.

Em Ações, selecione a opção "Acionar Webhook" no menu suspenso.

Escolha o tipo de solicitação de callback.

Embora cada aplicativo de terceiros possa usar um tipo de solicitação de forma diferente, a maioria dos aplicativos segue métodos padrão:

As solicitações GET são geralmente usadas para recuperar um ou todos os recursos.

As solicitações POST geralmente criam novos recursos.

As solicitações PUT e PATCH são usadas para atualizar um recurso.

As solicitações DELETE são geralmente usadas para excluir um recurso.

Neste exemplo, criamos uma solicitação POST, pois temos que criar uma nova mudança no módulo de mudança.

Especifique a URL de retorno de chamada (configurada para webhook) do aplicativo que você deseja acionar. Você pode tornar as URLs dinâmicas usando espaços reservados.

Por exemplo, se você deseja passar uma URL de retorno de chamada na forma: http://seuapp.com/suainfo?email=[email do usuário], você pode substituir a parte do email do usuário pelo espaço reservado {{requestor.email}}.

Testando Webhooks

Quando você tem fluxos de trabalho extensos com chamadas de webhook complexas, testá-las se torna obrigatório. Ativar fluxos de trabalho para testar os webhooks não é a maneira mais ideal de testá-los. Em vez disso, você pode testar seus webhooks diretamente no Workflow Automator.

Por exemplo, quando você configura um webhook para criar um chamado de mudança no módulo de mudança e clica no botão Testar webhook, um chamado de teste é criado no módulo de mudança se o teste for bem-sucedido.

As solicitações de API que resultam em erros retornarão um código de status HTTP apropriado para ajudá-lo a identificar o tipo de erro. Você pode usar esta tabela para entender o que cada código significa.

Se você precisa de autenticação, pode marcar a caixa de seleção Requer Autenticação. Você pode usar um nome de usuário/senha ou uma chave de API para autenticação. Neste caso, usaremos a chave de API da conta do Freshservice sendo configurada.

Escolha a codificação da solicitação que a aplicação de recurso suporta (JSON, XML ou XML codificado).

Para enviar simplesmente uma lista das propriedades do ticket que você deseja neste webhook, selecione a opção Conteúdo simples.

Se você deseja personalizar o conteúdo que está sendo enviado, selecione Avançado.

A opção avançada permite que você escreva solicitações de API personalizadas. Essas solicitações devem ser codificadas no formato escolhido na etapa anterior.

Você pode usar requestb.in ou postman - REST client (uma extensão do Google Chrome) para testar APIs.

O marcador de posição {{Triggered event}} está disponível apenas em Webhooks e retorna o nome do evento que acionou a regra.

Limites de Solicitações de Callback de Webhooks: O número de solicitações de webhook que você pode usar em uma hora é limitado a 1000 chamadas. Se os códigos de status estiverem entre 200 e 299, o callback será considerado um sucesso e os códigos de status entre 300-399 serão considerados redirecionamentos de callback.

Quando um callback falha (códigos de status diferentes de 2xx e 3xx), ou não recebe uma resposta em 15 segundos, o webhook será automaticamente reprocessado um máximo de 4 vezes em intervalos de 3, 5, 9 e 17 minutos.

Uma vez que a automação acima esteja ativada, qualquer ticket que chegue com o tipo "Solicitação de mudança" criará automaticamente uma mudança no módulo de mudanças.

Para mais informações acesse: https://support.freshservice.com/en/support/solutions/articles/157143-using-webhooks-with-the-workflow-automator