Integration von Airfocus mit Webhooks

Vorteile der Verwendung von Webhooks

Webhooks ermöglichen es AirFocus und anderen Apps, einfach und in Echtzeit zusammenzuarbeiten. Das bedeutet, dass Updates und Benachrichtigungen schnell ablaufen, ohne dass zusätzliche Apps oder kompliziertes Programmieren nötig sind.

Anfängliche Einrichtung eines neuen Webhooks

Erstellen Sie einen neuen Arbeitsbereich in airfocus oder wählen Sie den Arbeitsbereich aus, in dem Sie einen neuen Webhook erstellen möchten.

Anforderungen:

• „Vollständige“ Berechtigungen für den Arbeitsbereich, in dem Sie den Webhook setzen, bringen, einstellen möchten.
• Bezahltes Abonnement eines Professional- oder Enterprise-Tarifs.
• Technisches Wissen für die korrekte Konfiguration.

Sie können einem bestimmten Arbeitsbereich mehrere Webhooks hinzufügen (z. B. zu verschiedenen Slack Kanälen für unterschiedliche Stakeholder-Zielgruppen).

Gehen Sie dazu einfach im Der Arbeitsbereich zum Bereich „Erweiterungen“, klicken Sie auf „Integration hinzufügen“ und anschließend unter „Webhook “ auf „Verbinden“ .

Gib als Nächstes deinem Webhook einen Namen (optional) und wähle aus, für welche Ereignisse die Anfragen ausgelöst werden sollen.

In den Anfrageoptionen wähle das Platzhalter-Format und die Methode und füge deine Webhook-URL in das URL-Feld ein. Du kannst bei Bedarf auch Header zu deinen Anfragen hinzufügen.

Optional können Sie auch den Inhalt Ihrer Anfrage im oben ausgewählten Platzhalterformat konfigurieren.

{
 "Blöcke": [
 {
     "type": "divider"
   },
 {
 "Typ": "Abschnitt",
 "Text": {
 "type": "mrkdwn",
 "Text {{title|esc}}"
 },
 "Zubehör": {
 "Typ": "Schaltfläche",
 "text": {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
 "Wert": "click_me_123",
 "url": "{{url}}",
 „action_id“: „Schaltfläche-action“
 }
 },
 {
 "Typ": "Abschnitt",
 "Text": {
 "type": "mrkdwn",
 "text": "{{details|esc}}"
 }
 }
 ]
}

Für eine detaillierte Dokumentation der Anpassungsoptionen für Ihre Webhooks lesen Sie bitte den folgenden Abschnitt.

Anwendungsfall – Slack-Benachrichtigungen für AirFocus-Updates erhalten

In diesem Anwendungsfall ist unser Ziel, einen Webhook zu konfigurieren, der jedes Mal eine Slack -Nachricht an einen Kanal unserer Wahl sendet, wenn der Status eines Elements des Arbeitsbereichs, für das wir den Webhook konfigurieren, aktualisiert wird.

Dazu müssen wir eine Slack App einrichten, um eine Webhook-URL zu generieren, und anschließend den Rest der Integration in airfocus konfigurieren.

So erstellen Sie eine Webhook-URL für Ihren Slack-Kanal:

1. Erstelle eine neue Slack App im Slack Der Arbeitsbereich, in der du die airfocus-Benachrichtigungen empfangen möchtest.
   
   
2. Aktivieren Sie auf der Seite „Funktionen“ die Option „Eingehende Webhooks aktivieren“ .
   
3. Klicken Sie auf Neuen Webhook zu Der Arbeitsbereich hinzufügen.
   
4. Wähle einen Kanal aus, auf dem die App posten wird, und klicke dann auf Erlauben.
   
5. Kopieren Sie die Webhook-URL und öffnen Sie den airfocus Arbeitsbereich, für den Sie die Updates einrichten möchten.
   

So konfigurieren Sie Ihren Webhook in AirFocus, um Ereignisaktualisierungsbenachrichtigungen an Slack zu senden:

1. Klicken Sie im Popover „Erweiterungen“ auf „Integration hinzufügen“.
   
2. Klicken Sie in der Integrationsübersicht unter der Integration „Webhooks“ auf „Verbinden“.
   
3. Gib deinem Webhook einen Namen (optional) und wähle aus, für welche Events die Anfragen ausgelöst werden sollen. → "Status aktualisiert" für diesen Anwendungsfall.
   
4. Wählen Sie in den Anfrageoptionen „Slack Markdown“ als Platzhalterformat und „POST“ als Methode aus. Fügen Sie nun die Webhook-URL, die Sie aus Slack kopiert haben, in das URL-Feld ein.
   
5. Um korrekt formatierte Slack-Nachrichten zu erhalten, fügen Sie die folgende Vorlage in das Nachrichtenfeld ein und klicken Sie auf „Aktualisieren“.

   •  

     {
      "Blöcke": [
      {
          "type": "divider"
        },
      {
      "Typ": "Abschnitt",
      "Text": {
      "type": "mrkdwn",
      "Text {{title|esc}}"
      },
      "Zubehör": {
      "Typ": "Schaltfläche",
      "text": {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
      "Wert": "click_me_123",
      "url": "{{url}}",
      „action_id“: „Schaltfläche-action“
      }
      },
      {
      "Typ": "Abschnitt",
      "Text": {
      "type": "mrkdwn",
      "text": "{{details|esc}}"
      }
      }
      ]
     }

      

6. Sie erhalten nun eine Slack -Nachricht an den von Ihnen gewählten Kanal, sobald sich der Status eines Elements im Arbeitsbereich ändert.
   

Erhalten Sie airfocus-Updates in Microsoft Teams

Mit der Microsoft Teams Workflows-Funktion können Sie einen Webhook konfigurieren, der eine Teams -Nachricht an einen bestimmten Kanal sendet, wenn Elemente innerhalb eines bestimmten Arbeitsbereichs aktualisiert werden. Dazu müssen Sie eine Webhook-URL in Microsoft Teams generieren und anschließend die restliche Integration in airfocus konfigurieren.

Erstellen einer Webhook-URL in Microsoft Teams

Um eine Webhook-URL in Microsoft Teams zu generieren, befolgen Sie diese Schritte:

1. Melden Sie sich bei Microsoft Teams an.
2. Klicken Sie im Navigationsmenü ganz links auf das Dreipunkt-Menü.
3. Wählen Sie Arbeitsabläufe.
4. In der Suchleiste suchen Sie nach "webhook".
5. Wähle "Auf einem Kanal posten", wenn eine Webhook-Anfrage eingeht.
6. Gib einen Namen für deinen Workflow ein (z. B. "Airfocus-Updates").
7. Klicken Sie auf Weiter.
8. Wählen Sie unter „Details“ das jeweilige Team und den Kanal aus, auf dem die Aktualisierungen angezeigt werden sollen.
9. Klicken Sie auf Workflow hinzufügen.
10. Auf dem Bestätigungsbildschirm kopieren Sie die POST-URL.
    • Das ist die Webhook-URL, die du in AirFocus einfügen musst.
11. Klicken Sie auf Fertig, um die Einrichtung abzuschließen.

Konfigurieren Sie Ihren Webhook in AirFocus

Um Ihren Webhook in Airfocus zu konfigurieren, befolgen Sie diese Schritte:

1. Öffnen Sie den airfocus Arbeitsbereich, für den Sie Aktualisierungen an Microsoft Teams senden möchten.
2. Klicken Sie in der oberen rechten Ecke des Arbeitsbereichs auf „Erweiterungen“ .
3. Wählen Sie „Integration hinzufügen“.
4. Unter "Webhooks" klickst du auf Verbinden.
5. Gib einen Namen für den Webhook ein.
6. Wählen Sie unter „Ereignisse“ aus, welche Art von Aktualisierungen an Microsoft Teams gesendet werden sollen.
7. Unter "Platzhalter-Format" wählen Sie Markdown.
8. Wählen Sie unter „Methode“ die Option POST aus und fügen Sie anschließend die in Microsoft Teams generierte URL unter „URL“ ein.
9. Header auswählen + Hinzufügen.
10. Unter "Header name" geben Sie "Content-Type" ein.
11. Geben Sie unter „Header-Wert“ „Anwendung/json“ ein.
    
12. Um korrekt formatierte Microsoft Teams-Nachrichten zu erhalten, fügen Sie die folgende Vorlage in das Nachrichtenfeld ein.

    • {
        "type": "AdaptiveCard",
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
        "Version": "1.4",
        "Körper": [
          {
            "type": "TextBlock",
            "text": "{{title}}",
            "Größe": "Mittel",
            "Gewicht": "Kühner",
            "Wrap": Wahr
          },
          {
            "type": "TextBlock",
            "text": "{{details}}",
            "Wrap": Wahr
          }
        ],
        "Handlungen": [
          {
            "type": "Action.OpenUrl",
            "Titel": "Öffnen im Luftfokus",
            "URL": "{{url}}"
          }
        ]
      }

13. Klicken Sie unten rechts auf der Seite auf Aktualisieren .

Sie erhalten nun Aktualisierungen für den Microsoft Teams -Kanal, den Sie im ersten Abschnitt einrichten.
 

HTTP-Anfrage konfigurieren – technische Dokumentation

Methode

Es heißt setzen, bringen, einstellen und ist standardmäßig auf POST eingestellt, kann aber auch auf GET oder PUT geändert werden. Andere Methoden werden nicht unterstützt.

URL

• Darf nicht leer sein
• Es kann nur mit https:// geschrieben werden (andere Schemata oder ein leeres Schema werden nicht unterstützt).
• sollte einen öffentlichen Domainnamen mit einer bekannten Top-Level-Domain haben (IP-Adressen werden nicht unterstützt).

Kopfzeilen

• Die Autorisierung wird unterstützt
• Content-Type wird unterstützt
• Benutzerdefinierte Header, die mit x- beginnen, werden unterstützt
• andere Header werden nicht unterstützt

Textkörper

Definiert den Anfragetext des Webhooks.

Kann jeden Text von bis zu 2000 Zeichen lang enthalten.

Um den Request-Body mit sinnvollen Ereignisdaten auszufüllen, stellen wir eine Reihe von Platzhaltern bereit, die unser Server vor dem Versand der Anfrage durch Ereignisdaten ersetzt.

Platzhalter-Format

Legt an, wie die Platzhalter mit RichText-Typ von unserem Server vorgerendert werden sollen. Beispielsweise kann der Platzhalter {{title}} eine Zeichenkette wie „ John updated field Labels on Elemente Fix the Schaltfläche“ enthalten, die Rich-Text-Formatierungen wie Fettdruck, Kursivschrift usw. enthält. Daher gibt das Platzhalterformat an, in welcher spezifischen Syntax diese Formatierung umgewandelt werden soll. Verfügbare Formate:

Platzhalter

Datenmodelle

Event Payload Das Modell

Ein Objekt der obersten Ebene, das für jedes Ereignis erzeugt wird. Es enthält Daten über das Ereignis sowie eingebettete Basisdaten über alle Entitäten, die mit diesem Ereignis in Zusammenhang stehen.

Event Das Modell

Grundlegende Daten zum Ereignis

EventInitiator Das Modell

Informationen darüber, wer diese Veranstaltung initiiert hat. In den meisten Fällen wird die UserId definiert. Es ist auch möglich, dass sowohl userId als auch integrationId definiert sind – z. B. wenn ein Nutzender die Schaltfläche „Integration synchronisieren“ gedrückt hat, wodurch das Ereignis ausgelöst wurde.

EventEmbed Das Modell

Zusätzliche Daten zum Ereignis – hauptsächlich Namen von Elementen/Arbeitsbereich/Feldern usw., die mit diesem Ereignis in Zusammenhang stehen.

TeamInfo Das Modell

Benutzerinformationen Das Modell

AppInfo Das Modell

WorkspaceInfo Das Modell

Integrationsinformationen Das Modell

StatusInfo Das Modell

Artikelinformationen Das Modell

EventData Das Modell

EventData ist ein Union-Typ – es kann eines der angegebenen Typen sein:

Erstelltes Element

UpdatedItem

Geben Sie uns Feedback zu diesem Artikel