Dieser Leitfaden hilft Ihnen bei der Einrichtung einer Webhook-Integration, um Warnungen von Dotcom-Monitor an Ihre Jira-Tickets zu senden. Dotcom-Monitor nutzt die HTTP-Webhook-Benachrichtigungsübermittlungsmethode, um das Dotcom-Monitor-Warnsystem und Jira-Tickets über Webhook-Anfragen zu verbinden. Um die Integration einzurichten, stellen Sie sicher, dass Sie über die erforderlichen Berechtigungen zum Erstellen von Vorgängen in Ihrem Jira-Projekt verfügen.

Einrichtung der Integration

Jira-API-Token generieren:

  1. Bitte besuche die Seite Basic auth for REST APIs des Atlassian Developer-Portals, um zu erfahren, wie du ein API-Token generierst und die Standardauthentifizierung mit Jira einrichtest.
  2. Speichern Sie das generierte API-Token für die Verwendung im Autorisierungsheader in Dotcom-Monitor.

Konfigurieren des Webhooks in Dotcom-Monitor

Bei der Verwendung von API-Anfragen, insbesondere bei Authentifizierungsheadern, benötigt JIRA manchmal einen zusätzlichen Header, um den CSRF-Schutz zu umgehen. Um dieses Problem zu beheben, fügen Sie den X-Atlassian-Token-Header mit dem Wert no-check in Ihre Webhook-Anfrage ein.

  1. Melden Sie sich bei Ihrem Dotcom-Monitor-Konto an und gehen Sie zur Konfiguration der Lieferadressgruppen (Zustellungsadressgruppe verwalten > ).
  2. Erstellen Sie eine neue Gruppe, oder öffnen Sie eine vorhandene Gruppe zur Bearbeitung. Fügen Sie den Webhook als Lieferadresse hinzu. Im Artikel HTTP-Webhook-Integration erfahren Sie, wie Sie Dotcom-Monitor-Warnmeldungen an eine dedizierte Webhook-URL senden.
  3. Geben Sie im Feld Webhook-URL Folgendes ein: https://your-domain.atlassian.net/rest/api/3/issue
  4. Legen Sie den Anforderungstyp auf POST fest.
  5. Lassen Sie den Abschnitt Authentifizierung leer.
  6. Fügen Sie im Abschnitt Headers die folgenden Header hinzu. Stellen Sie sicher, dass die Zeichenfolge useremail:api_token mit BASE64 codiert ist:
    • Berechtigung: Basic [useremail:api_token]
    • Inhaltstyp: application/json
    • X-Atlassian-Token: no-check
  7. Geben Sie im Feld Payload die JSON-Datenstruktur ein, die an Jira gesendet wird. Hier ist ein Beispiel für eine Nutzlast:
    @{
    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. Ersetzen Sie "PROJECT_KEY" durch den Schlüssel Ihres Jira-Projekts.

Testen des Webhooks

Nachdem die Webhook-Integration konfiguriert wurde, empfehlen wir, Ihr Überwachungsgerät zu testen, indem Sie eine Testwarnung senden:

  1. Bewegen Sie den Mauszeiger in der Geräteliste über das Überwachungsgerät, das Sie testen möchten.
  2. Klicken Sie auf das Menü Optionen (⋮) > Testalarm > nach unten senden.
  3. Überprüfen Sie Ihr Jira-Projekt, um festzustellen, ob die Benachrichtigung ein neues Ticket erstellt hat.

Verwenden dynamischer Variablen in der Warnungsvorlage

Wenn Sie dynamische Dotcom-Monitor-Variablen in Ihre JSON-Nutzlast aufnehmen müssen, lesen Sie bitte den Artikel Hinzufügen dynamischer Variablen zur Warnungsvorlage . Wenn Sie auf Probleme stoßen oder spezielle Anforderungen haben, wenden Sie sich bitte an den Dotcom-Monitor-Support, um weitere Unterstützung zu erhalten.