Usando Webhooks com o Automatizador de Fluxo de Trabalho

Criada por Renan Bernal Bernal Camargo, Modificado em Thu, 30 Jul 2020 na (o) 04:38 PM por Renan Bernal Bernal Camargo

O que é um Webhook?

Um Webhook é um "retorno de chamada" para um aplicativo ou serviço da Web que é acionado quando ocorre um evento específico. Quando determinadas atualizações, alterações ou ações ocorrem, 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 para acionar um Webhook quando ocorrer um evento específico.

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

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

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

O que você quer fazer	Condições a procurar	Como o Webhook deve chamar
Enviar uma mensagem SMS / texto quando o cliente responder ao ticket	O cliente responde ao ticket (ou adiciona comentário)	Enviar conteúdo de comentários para a ferramenta SMS de terceiros
Atualizar inventário quando uma solicitação de devolução de produto é atualizada	A categoria do ticket (um campo personalizado) é atualizada para "Devolução do produto"	Atualizar informações do produto no inventário da loja
Status de sincronização para solicitações de recursos com a ferramenta interna de gerenciamento de produtos	O status é atualizado para tickets do tipo "Solicitação de recurso"	Atualizar ferramenta de gerenciamento de produtos com informações de ticket
Soam toques e sirenes quando a classificação de Satisfação do Cliente é Recebida	O feedback do cliente é recebido e a classificação é "Não é boa"	Personalize um Bulbo Inteligente (como este ou este ) e uma placa de som de sirene para acionar este Webhook

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

Vamos considerar o seguinte caso de uso:

Crie uma alteração automaticamente sempre que um Ticket for uma solicitação de alteração.

Crie um novo fluxo de trabalho usando o Automatizador de Fluxo de Trabalho. 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 retorno de chamada.
Embora cada aplicativo de terceiros possa usar um tipo de solicitação de uma maneira diferente, a maioria dos aplicativos segue métodos padrão:
- Solicitações GET geralmente são usadas para recuperar um ou todos os recursos.
- As solicitações POST geralmente criam novos recursos.
- Solicitações PUT e PATCH são usadas para atualizar um recurso.
- As solicitações DELETE geralmente são usadas para excluir um recurso.

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

Especifique o URL de retorno de chamada (configurado para webhook) do aplicativo que você deseja acessar. Você pode dinamizar os URLs usando espaços reservados.
Por exemplo, se você deseja transmitir um URL de retorno de chamada do formulário: http://yourapp.com/yourInfo?e-mail=[user e-mail], você pode substituir a parte do e-mail do usuário pelo espaço reservado {{requestor.e-mail}} .

Testando Webhooks

Quando você tem grandes fluxos de trabalho com chamadas complexas de webhook, 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 Automatizador de Fluxo de Trabalho.

Por exemplo, quando você configura um webhook para criar um Ticket de mudança no módulo de mudança e pressiona o botão Testar webhook, um Ticket 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 ajudar a identificar o tipo de erro. Você pode usar esta tabela para entender o que cada código significa.

Nota: Os espaços reservados não são suportados para Testar Webhooks.

Se você precisar de autenticação, poderá habilitar 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. Usamos a chave API da conta Freshservice que está sendo configurada neste caso de uso.
Escolha a codificação da sua solicitação que o aplicativo de recurso suporta (JSON, XML ou XML-Codificado).

Para simplesmente enviar uma lista de 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 escrever solicitações de API personalizadas. Esses pedidos devem ser codificados no formato que você escolheu na etapa anterior.
Você pode usar requestb.in ou postman - cliente REST (uma extensão do google chrome) para testar APIs.
O espaço reservado {{Triggered event}} está disponível apenas no Webhooks e retorna o nome do evento que acionou a regra.

Limites de solicitação de retorno de chamada do Webhook : o número de solicitações de retorno da web que você pode usar em 1 hora é limitado a 1000 chamadas. Se os códigos de status estiverem entre 200 e 299, o retorno de chamada será um sucesso e os códigos de status entre 300-399 serão considerados como redirecionamentos de retorno de chamada. Quando um retorno de chamada falha (códigos de status diferentes de 2xx e 3xx), o webhook será tentado novamente automaticamente a cada 30 minutos, totalizando 48 chamadas. As chamadas solicitadas após o limite da taxa serão armazenadas em buffer até que novas chamadas estejam disponíveis após 1 hora.

Depois que a automação acima estiver ativada, qualquer Ticket que entrar com o tipo "Solicitação de alteração" criará automaticamente uma alteração no módulo de alteração.