Usando webhooks em regras de automação que são executadas em atualizações de tickets

Criada por Suporte Bravo, Modificado em Seg, 4 Jul, 2022 na (o) 2:45 PM por Isabelle Fernandes

Indisponível apenas no plano Free.

Você pode criar uma regra de automação que é executada em atualizações de tíquetes para acionar uma chamada de webhooks assim que os eventos especificados ocorrerem.

O que é uma chamada de webhooks?

Um webhook é um 'retorno de chamada' para um aplicativo ou serviço da web que é acionado quando ocorre um evento específico; essencialmente, um webhook permite que você procure por uma atualização, mudança ou ação específica e, uma vez que ocorre, ele envia automaticamente as informações que você especifica para onde você quiser.

O que você pode fazer com uma chamada de webhooks de uma automação executada em atualizações de tíquetes?

A automação executada nas atualizações de tíquetes é acionada quando um evento específico ocorre em um tíquete. Usando apenas esta regra, você pode atualizar, modificar, enviar notificações e executar ações no Freshdesk. Por exemplo, você pode atualizar as prioridades do tíquete, enviar e-mails de escalonamento e assim por diante.

Os webhooks também são úteis quando você deseja acionar uma ação em um aplicativo ou ferramenta externa (bem como algumas atualizações que a regra de automação não pode realizar, como atualizar a entrada de tempo em um tíquete ou adicionar uma nota a um tíquete). Aqui estão alguns exemplos de cenários em que você pode usar webhooks:

O que você quer fazer	Condições para procurar	Como o webhook deve chamar
Envie um SMS / mensagem de texto quando um cliente responder a um tíquete	O cliente responde ao tíquete (ou adiciona um comentário)	Envie o conteúdo do comentário para uma ferramenta SMS de terceiros
Atualize o estoque quando uma solicitação de devolução de produto for atualizada	A categoria de ingresso (um campo personalizado) é atualizada para 'Devolução de produto'	Atualizar informações do produto no estoque 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 produto com informações de tíquetes
Soe o alarme quando uma classificação de Satisfação do Cliente Insatisfatória for recebida	O feedback do cliente é recebido e a avaliação é 'Não é boa'	Personalize uma lâmpada inteligente e uma caixa de som de sirene para disparar acionada por este webhook

Um guia rápido para configurar uma solicitação de webhook em uma regra de automação executada em atualizações de tíquetes:

Crie uma nova regra (em Admin> Fluxos de trabalho> Automações> guia Atualizações de tíquetes) e selecione Acionadores e condições ( saiba como ).
Em executar essas ações , selecione a opção Trigger Webhook.
- Escolha o tipo de solicitação de retorno de chamada . Embora cada aplicativo de terceiros possa usar um tipo de solicitação de maneira diferente, a maioria dos aplicativos segue estes métodos padrão:
  - As solicitações GET são normalmente 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 geralmente são usadas para excluir um recurso.

Se você deseja configurar uma regra para adicionar uma nota a um ticket com base em certas condições e gatilhos, é POST porque você está adicionando uma nota ( mais informações aqui ).

Especifique o URL de retorno de chamada (configurado para webhook) do aplicativo que você deseja acessar. Você pode tornar os URLs dinâmicos usando espaços reservados.
- Por exemplo, para adicionar a nota a um tíquete, você deve especificar a qual tíquete deseja que a nota seja adicionada. Seu URL de retorno de chamada seria: https://acme.freshdesk.com/api/v2/tickets/{{ticket.id}}/notes com o espaço reservado {{ticket.id}}.
Adicione cabeçalhos personalizados para transmitir informações adicionais, como detalhes de segurança, detalhes da versão da API e assim por diante. Um cabeçalho personalizado deve ser inserido como um par cabeçalho-valor seguindo o formato especificado X-Sample-CustomHeader1: VALUE .
Observação: o acionador não será executado quando um cabeçalho for fornecido com espaços entre eles, como X-Sample Custom Header1: VALUE. Porém, se um espaço for inserido no final do cabeçalho, ele será ignorado.
Um cabeçalho contendo mais de um valor deve ser separado por delimitadores (vírgulas e dois pontos não podem ser usados como delimitadores). Para adicionar um segundo cabeçalho, insira o cabeçalho personalizado e o par de valores na próxima linha.
Escolha a codificação de sua solicitação que o aplicativo de recurso suporta (JSON, XML ou XML-Encoded). Para o exemplo de adição de nota, é JSON.
Para simplesmente enviar uma lista das propriedades do tíquete que você deseja neste webhook, selecione a opção Conteúdo simples. Adicionar uma nota não requer nenhuma das propriedades usuais do tíquete, então você terá que escrever uma solicitação de API personalizada.
Se desejar 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. Para nosso exemplo de adição de nota, esta é a aparência da solicitação de API:

Se você gostaria de adicionar uma nota privada, coloque 'private: true' na solicitação. Você também pode personalizar o conteúdo em suas solicitações de API, tornando-as dinâmicas usando espaços reservados . Se você quiser fazer mais com a API do Freshdesk do que apenas adicionar uma nota, uma infinidade de opções estão disponíveis . Você pode usar requestb.in ou postman - cliente REST (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ção de retorno de chamada de webhook: 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 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á repetido automaticamente uma vez 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.