Integração com Atlassian | Enviar notificações de alerta do Dotcom-Monitor para o Jira

Este guia ajudará você a configurar uma integração de webhook para enviar alertas do Dotcom-Monitor para seus tíquetes do Jira. O Dotcom-Monitor aproveita o método de entrega de alertas HTTP Webhook para conectar o sistema de alertas Dotcom-Monitor e os tíquetes do Jira por meio de solicitações de webhook. Para configurar a integração, certifique-se de ter as permissões necessárias para criar problemas em seu projeto do Jira.

Configuração de integração

Gerar token de API do Jira:

1. Visite a página Autenticação básica para APIs REST do portal do Atlassian Developer para saber como gerar um token de API e configurar a autenticação básica com o Jira.
2. Salve o token de API gerado para uso no cabeçalho de autorização no Dotcom-Monitor.

Configurar o webhook no Dotcom-Monitor

1. Faça login na sua conta do Dotcom-Monitor e vá para a configuração de grupos de endereços de entrega (Gerenciar > grupo de endereços de entrega).
2. Crie um novo grupo ou abra um existente para edição. Adicione webhook como endereço de entrega. Visite o artigo Integração de Webhook HTTP para saber como enviar mensagens de alerta do Dotcom-Monitor para um URL de webhook dedicado.
3. No campo URL do webhook, insira: https://your-domain.atlassian.net/rest/api/3/issue
4. Defina o Tipo de solicitação como POST.
5. Deixe a seção Autenticação vazia.
6. Na seção Cabeçalhos , adicione os seguintes cabeçalhos. Certifique-se de codificar BASE64 a string useremail:api_token .:
   • Autorização: Basic [useremail:api_token]
   • Tipo de conteúdo: application/json
   • X-Atlassian-Token: no-check
7. No campo Payload , insira a estrutura de dados JSON que será enviada ao Jira. Aqui está um exemplo de carga:

   @{
   string _text = "";
   foreach (var sessionResponse in Model.SessionResponses)
   {
       foreach (var response in sessionResponse.Children)
       {
           _text += "Task Type: " + response.Task.TaskType_Name + ", " +
                    "Details Url: " + Model.DMUserLink + "/client/response-details/hit?id=" + response.ID + "&rootId=" + Model.RootResponse.ID + "&cuid=" + Model.OnlineReportCUID + ", " +
                    "View Task Url: " + Model.DMUserLink + "/v2/EditLegacyTask/" + response.Device.ID + "/" + response.Task.ID + ", " +
                    "Task Name: " + response.Name + ", " +
                    "Target: " + response.Target + ", ";
   
           if (response.AllErrors != null)
           {
               foreach (var error in response.AllErrors)
               {
                   _text += error.ErrorType + " (" + error.ErrorCode + ") " + error.Reason;
               }
           }
       }
   }
   }
   {
     "fields": {
       "project": {
         "key": "JIRA_PROJECT_KEY"
       },
       "summary": "Alert from Dotcom-Monitor",
       "description": {
         "type": "doc",
         "version": 1,
         "content": [
           {
             "type": "paragraph",
             "content": [
               {
                 "text":"@_text",
                 "type": "text"
               }
             ]
           }
         ]
       },
       "issuetype": {
         "name": "Task"
       },
       "components": [
         {
           "name": "Default Component"
         }
       ]
     }
   }
   

8. Substitua "PROJECT_KEY" pela chave do seu projeto Jira.

Testar o Webhook

Depois que a integração do webhook for configurada, recomendamos testar seu dispositivo de monitoramento enviando um alerta de teste:

1. Na lista de dispositivos, passe o mouse sobre o dispositivo de monitoramento que deseja testar.
2. Clique no menu Opções (⋮) > Enviar alerta > de teste para baixo.
3. Verifique seu projeto do Jira para ver se o alerta criou um novo ticket.

Usando variáveis dinâmicas no modelo de alerta

Se você precisar incluir variáveis dinâmicas do Dotcom-Monitor em sua carga JSON, verifique o artigo Adicionando variáveis dinâmicas ao modelo de alerta . Se você encontrar algum problema ou tiver requisitos específicos, entre em contato com o suporte do Dotcom-Monitor para obter mais assistência.