Zintegruj airfocus z Webhookami

Korzyści z używania haczyków

Webhook umożliwiają łatwą współpracę airfocus i innych aplikacji w czasie rzeczywistym. Oznacza to, że aktualizacje i powiadomienia odbywają się szybko, bez konieczności korzystania z dodatkowych aplikacji lub skomplikowanego kodowania.

Początkowa konfiguracja nowego haczyka

/utworz/ nową przestrzeń roboczą w airfocus lub wybierz tę, w której chcesz /utworz/ utworzyć nowy webhook.

Wymagania:

• „Pełne” uprawnienia do obszaru roboczego, w którym chcesz skonfigurować webhook.
• Płatny abonament w planie Professional lub Przedsiębiorstwo.
• Wiedza techniczna dla prawidłowej konfiguracji.

Do danego obszaru roboczego można dodać wiele haczyków internetowych (np. do różnych kanałów Slack dla różnych odbiorców interesariuszy).

Aby to zrobić, po prostu przejdź do sekcji Rozszerzenia w swoim obszarze roboczym, kliknij " Dodaj integracje " i " Connect " pod Webhook.

Następnie nadaj swojemu webhakowi nazwę (opcjonalnie) i wybierz, dla których zdar zeń żądania powinny być uruchamiane.

W opcjach żądania wybierz format zastępczy i metodę i wklej adres URL haczyka internetowego w polu URL. W razie potrzeby możesz także dodawać nagłówki do żądań.

Opcjonalnie można również skonfigurować treść żądania w wybranym powyżej formacie symbolu zastępczego.

{
 "bloki": [
 {
     "type": "divider"
   },
 {
 „typ”: „sekcja”,
 "tekst": {
 "typ": "mrkdwn",
 "Tekst {{title|esc}}"
 },
 "akcesorium": {
 "typ": "przycisk",
 "tekst": {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
 "wartość": "kliknij_mnie_123",
 "url": "{{url}}",
 "action_id": "działanie przycisku"
 }
 },
 {
 „typ”: „sekcja”,
 "tekst": {
 "typ": "mrkdwn",
 "tekst": "{{details|esc}}"
 }
 }
 ]
}

Aby uzyskać szczegółową dokumentację opcji dostosowywania dla twoich webhooków, przeczytaj poniższą sekcję.

Przypadek użycia - otrzymuj powiadomienia Slack o aktualizacjach airfocus

W tym przypadku użycia naszym celem jest skonfigurowanie haczyka internetowego, który wyśle wiadomość Slack do wybranego przez nas kanału za każdym razem, gdy element obszaru roboczego, dla którego konfigurujemy haczyk internetowy, uzyska aktualizację statusu.

Aby to zrobić, musimy skonfigurować aplikację Slack, aby wygenerować adres URL webhook, a następnie skonfigurować resztę integracji w airfocus.

Jak utworzyć adres URL webhooka dla swojego kanału Slack:

1. /utworz/ nowa aplikacja Slack w przestrzeni roboczej Slack, na którą chcesz otrzymywać powiadomienia AirFocus.
   
   
2. Na stronie Funkcje włącz opcję Aktywuj przychodzące sieci Web Hooks.
   
3. Kliknij Dodaj nowy Webhook do obszaru roboczego.
   
4. Wybierz kanał, na którym aplikacja będzie publikować, a następnie kliknij Zez wól.
   
5. Skopiuj adres URL webhook i otwórz obszar roboczy airfocus, dla którego chcesz skonfigurować aktualizacje.
   

Jak skonfigurować webhook w airfocus, aby wysyłać powiadomienia o aktualizacji zdarzeń do Slack:

1. W wyskakującym okienku rozszerzeń kliknij „Dodaj integracje”.
   
2. W przeglądzie integracji kliknij „Połącz” pod integracją „Webhook”.
   
3. Nadaj swojemu webhakowi nazwę (opcjonalnie) i wybierz, dla których zdarzeń żądania powinny być uruchamiane. → „Status zaktualizowany” dla tego przypadku użycia.
   
4. W opcjach żądania wybierz „Slack markdown” jako format symbolu zastępczego i „POST” jako metodę. Teraz wklej adres URL webhook skopiowany z Slacka do pola URL.
   
5. Aby otrzymywać poprawnie sformatowane wiadomości Slack, wklej poniższy szablon w polu treści i naciśnij przycisk aktualizuj.

   •  

     {
      "bloki": [
      {
          "type": "divider"
        },
      {
      „typ”: „sekcja”,
      "tekst": {
      "typ": "mrkdwn",
      "Tekst {{title|esc}}"
      },
      "akcesorium": {
      "typ": "przycisk",
      "tekst": {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
      "wartość": "kliknij_mnie_123",
      "url": "{{url}}",
      "action_id": "działanie przycisku"
      }
      },
      {
      „typ”: „sekcja”,
      "tekst": {
      "typ": "mrkdwn",
      "tekst": "{{details|esc}}"
      }
      }
      ]
     }

      

6. Otrzymasz teraz wiadomość Slack na wybrany kanał, gdy zmienił się status dowolnego elementu w obszarze roboczym.
   

Otrzymuj aktualizacje airfocus w Microsoft Zespole

Funkcja Microsoft Zespół Workflows umożliwia skonfigurowanie webhooka, który wysyła wiadomość Zespół do wyznaczonego kanału, gdy elementy w określonym obszarze roboczym AirFocus zostaną zaktualizowane. Aby to zrobić, musisz wygenerować adres URL webhooka w Microsoft Zespół, a następnie skonfigurować resztę integracji w airfocus.

/utworz/ adres URL webhooka w zespole Microsoft

Aby wygenerować adres URL webhooka w programie Microsoft Zespół, wykonaj następujące kroki:

1. Zaloguj się do Microsoft Zespół.
2. Kliknij menu z trzema kropkami w menu nawigacyjnym po lewej stronie.
3. Select workflow.
4. W pasku wyszukiwania wyszukaj „webhook”.
5. Wybierz opcję Opublikuj na kanale po otrzymaniu żądania webhook.
6. Wpisz nazwę swojego workflow (np. „Aktualizacje Airfocus”).
7. Kliknij przycisk Dalej.
8. W sekcji „Szczegóły” wybierz konkretny Zespół i Kanał, w którym mają pojawiać się aktualizacje.
9. Kliknij Dodaj workflow.
10. Na ekranie potwierdzenia skopiuj adres URL POST.
    • To jest adres URL webhook, który musisz wkleić do airfocus.
11. Kliknij przycisk Gotowe, aby zakończyć konfigurację.

Skonfiguruj swój webhook w airfocus

Aby skonfigurować haczyk internetowy w airfocus, wykonaj następujące kroki:

1. Otwórz obszar roboczy AirFocus, dla którego chcesz wysyłać aktualizacje do Microsoft Zespół.
2. Kliknij opcję Rozszerzenia w prawym górnym rogu obszaru roboczego.
3. Wybierz Dodaj integracje.
4. W sekcji „Webhook” kliknij Połącz.
5. Wpisz nazwę haczyka sieciowego.
6. W sekcji „Wydarzenia” wybierz typ aktualizacji, które chcesz otrzymywać od Microsoft Zespół.
7. W polu „Format symbolu zastępczego” wybierz opcję Mark down.
8. W obszarze „Metoda” wybierz opcję POST , a następnie wklej adres URL wygenerowany w programie Microsoft Zespół w polu „URL”.
9. Wybierz polec enie+Dodaj nagłówek.
10. W polu „Nazwa nagłówka” wpisz „Content-Type”.
11. W polu „Wartość nagłówka” wpisz „application/json”.
    
12. Aby otrzymywać poprawnie sformatowane wiadomości Microsoft Zespół, wklej poniższy szablon w polu treści.

    • {
       " typ ": " AdaptiveCard ",
       " $schemat ": " http://adaptivecards.io/schemas/adaptive-card.json",
       " wersja ": " 1.4 ",
        "ciało": [
       {
       „typ”: „Blok tekstu”,
       "tekst": "{{title}}",
       „rozmiar”: „Średni”,
       „waga”: „Odważniejszy”,
       „wrap”: prawda
       },
       {
       „typ”: „Blok tekstu”,
       "Tekst {{details}}",
       „wrap”: prawda
       }
       ],
       "działanie": [
       {
       "type": "działanie.OpenUrl",
       „tytuł”: „Otwórz w Airfocus”,
       "url": "{{url}}"
       }
       ]
       }

13. Kliknij Aktualiz uj w prawym dolnym rogu strony.

Teraz będziesz otrzymywać aktualizacje kanału Microsoft Zespół skonfigurowanego w pierwszej sekcji.
 

Konfigurowanie żądania HTTP - dokumentacja techniczna

Metoda

Domyślnie jest ustawiony na POST, ale można go również zmienić na GET lub PUT. Inne metody nie są obsługiwane.

URL

• nie powinien być pusty
• może zaczynać się tylko od https://(inne schematy lub pusty schemat nie są obsługiwane)
• powinien mieć nazwę domeny publicznej ze znaną domeną najwyższego poziomu (adresy IP nie są obsługiwane)

Nagłówki

• Autoryzacja jest obsługiwana
• Obsługiwany jest typ zawartości
• obsługiwane są niestandardowe nagłówki zaczynające się od x-
• inne nagłówki nie są obsługiwane

Ciało

Definiuje treść żądania webhook.

Może zawierać dowolny tekst o długości do 2000 znaków.

Aby wypełnić treść żądania znaczącymi danymi zdarzeń, udostępniamy kilka symboli zastępczych, które nasz serwer zastępuje danymi zdarzeń przed wysłaniem żądania.

Format symbolu zastępczego

Określa, w jaki sposób symbole zastępcze z typem RichText powinny być wstępnie renderowane przez nasz serwer. Na przykład symbol zastępczy {{title}} może zawierać ciąg znaków typu „John zaktualizował etykiety pól na elemencie Nap raw przycisk”, który zawiera formatowanie tekstu bogatego, takie jak pogrubienie, kursywa itp., dlatego format symbolu zastępczego określa, w jakiej konkretnej składni formatowanie powinno zostać przekształcone. Dostępne formaty:

Symbole zastępcze

Modele danych

Model ładunku zdarzenia

Obiekt najwyższego poziomu, tworzony dla każdego zdarzenia. Zawiera dane dotyczące zdarzenia, a także osadzone podstawowe dane dotyczące wszystkich podmiotów powiązanych z tym zdarzeniem.

Model zdarzenia

Podstawowe dane o wydarzeniu

Model EventInitiator

Informacje o tym, kto zainicjował to wydarzenie. W większości przypadków identyfikator użytkownika zostanie zdefiniowany. Możliwe jest również, że zostaną zdefiniowane zarówno userId, jak i IntegrationID - np. jeśli użytkownik nacisnął przycisk „synchronizuj integrację”, który następnie wygenerował zdarzenie.

EventEmbed Model

Dodatkowe dane o wydarzeniu - głównie nazwy przedmiotów/przestrzeni roboczej/pol/itp., które są związane z tym wydarzeniem.

Model TeamInfo

Model UserInfo

Model AppInfo

Model WorkspaceInfo

IntegrationInfo Model

Model StatusInfo

Model ItemInfo

Model EventData

EventData jest typem zjednoczenia - może dowolny z określonych typów:

UtwórzEdytuj

AktualizacjaEdytuj

Przekaż opinię na temat tego artykułu