Os webhooks permitem enviar dados de tickets para outro sistema automaticamente quando condições específicas são atendidas. Essa abordagem é frequentemente mais simples do que uma configuração de API bidirecional, já que o sistema receptor não precisa iniciar uma solicitação de API para obter os dados do Atendimento de Suporte.

Para saber mais sobre gatilhos, recomendamos revisar o artigo Gatilhos. Esses recursos explicam conceitos essenciais, terminologia e como configurar condições de gatilho—conhecimentos cruciais para configurar gatilhos de webhook de forma eficaz.

Glossário

REST API: Um framework padronizado que permite a comunicação entre diferentes sistemas via web.
POST Method: Uma solicitação REST API usada para enviar dados para um servidor.
Data Packet: Uma unidade estruturada de dados formatada para transmissão.
JSON: Um formato de arquivo amplamente usado para transmitir dados.

Configurar Webhook no Atendimento de Suporte

Para criar um webhook:

1. Navegue até Configurações > Automações > Gatilhos > Webhooks e crie um gatilho do tipo Ticket.

2. Configure as condições do gatilho para corresponder aos cenários onde o webhook deve ser executado.

3. Selecione a ação de gatilho do Webhook e insira o URL onde a solicitação POST será enviada. A solicitação incluirá um pacote de dados JSON contendo informações do ticket.
   💡Dica: Você pode adicionar ações adicionais ao gatilho do webhook, como criar uma nota para registrar que as informações do ticket foram enviadas para outro sistema. Todas as ações configuradas serão executadas quando o gatilho for disparado.

4. Certifique-se de que o sistema receptor esteja configurado para aceitar e processar a solicitação POST do Atendimento de Suporte.

Pacote de Dados JSON

Quando um gatilho de webhook é disparado, ele envia uma solicitação POST para o URL especificado. A solicitação contém um pacote de dados JSON com detalhes sobre o ticket. Aqui está um detalhamento da estrutura dos dados:

Campos Principais

Estrutura JSON de Exemplo

{
  "Id": int,
  "Subject": string,
  "Status": string,
  "Justification": string,
  "Actions": [
    {
      "Id": int,
      "Description": string,
      "HtmlDescription": string,
      "Attachments": [
        {
          "FileName": string,
          "Path": string,
          "CreatedBy": {
            "Id": string,
            "PersonType": int,
            "ProfileType": int,
            "BusinessName": string,
            "Email": string,
            "Phone": string
          },
          "CreatedDate": string
        }
      ]
    }
  ],
  "WebhookEvents": [
    {
      "Criteria": int,
      "Operator": int
    }
  ],
  "Urgency": string,
  "ServiceFirstLevel": string,
  "CustomFieldValues": [
    {
      "CustomFieldId": int,
      "CustomFieldRuleId": int,
      "Line": int,
      "Value": string,
      "Items": [
        {
          "PersonId": string,
          "ClientId": string,
          "Team": string,
          "CustomFieldItem": string,
          "StorageFileGuid": string,
          "FileName": string
        }
      ]
    }
  ],
  "SlaSolutionTime": int
}

Entendendo o Log de Execução do Webhook

Para monitorar as tentativas de execução do webhook, navegue até Configurações > Automações > Gatilhos > Webhooks > Webhook Execution Log. Este log exibe todas as instâncias em que um gatilho com a ação Trigger Webhook foi disparado. Use filtros como data, número do ticket e mensagens de erro para refinar sua busca.

O log de execução é particularmente útil para testar ou solucionar problemas com webhooks. Por exemplo, ele mostra se o sistema receptor rejeitou a solicitação POST e retornou um erro.