Integrera airfocus med Webhooks

Fördelar med att använda webhooks

Webhooks låter airfocus och andra appar arbeta tillsammans enkelt och i realtid. Detta innebär att uppdateringar och aviseringar sker snabbt utan att behöva extra appar eller komplicerad kodning.

Inledande installation av en ny webhook

Skapa en ny arbetsyta i airfocus, eller välj den där du vill skapa en ny webhook.

Krav:

• ”Fullständiga” behörigheter till arbetsytan där du vill ställa in webhooken.
• Betald prenumeration på Professional- eller Enterprise-planen.
• Teknisk kunskap för korrekt konfiguration.

Du kan lägga till flera webhooks till en viss arbetsyta (t.ex. till olika Slack-kanaler för olika intressentgrupper).

För att göra det, gå helt enkelt till avsnittet Tillägg i din arbetsyta, klicka på " Lägg till integrationer " och " Anslut " under Webhook.

Ge sedan din webhook ett namn (valfritt) och välj vilka händelser förfrågningarna ska utlösas för.

Välj platshållar format och metod i förfrågningsalternativen och klistra in web hook-webbadressen i URL- fältet. Du kan också lägga till rubriker till dina förfrågningar om det behövs.

Alternativt kan du också konfigurera förfrågningens brödtext i platshållarformatet som valts ovan.

{
 " block ": [
   {
     "type": "divider"
   },
   {
     " typ ": " section ",
     " text ": {
       " typ ": " mrkdwn ",
       " text ": "{{title|esc}}"
     },
     " tillbehör ": {
       " " " ",,
       "
       ": {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
       " värde ": " click_me_123 ",
       " url ": "{{url}}", " ": " knappåtgärd "
     }}
   },
   {
     " typ ": " section ",
     " text ": {
       " typ ": " mrkdwn ",
 " text ": "{{details|esc}}<span  



translate="sv">55}}]}

För detaljerad dokumentation av anpassningsalternativ för dina webhooks, läs följande avsnitt.

Användningsfall – få Slack-aviseringar för airfocus-uppdateringar

För detta användningsfall, vårt mål är att konfigurera en webhook som skickar ett Slack-meddelande till en kanal som vi väljer varje gång ett objekt i arbetsytan vi konfigurerar webhooken för får sin status uppdaterad.

För att göra det måste vi konfigurera en Slack-app för att generera en webhook-URL och sedan konfigurera resten av integrationen i airfocus.

Så här skapar du en webhook-URL till din Slack-kanal:

1. Skapa en ny Slack-app i Slack-arbetsytan där du vill ta emot airfocus -aviseringar.
   
   
2. Från sidan Funktioner aktiverar du alternativet Aktivera inkommande webhooks.
   
3. Klicka på Lägg till ny webhook i arbetsytan.
   
4. Välj en kanal som appen ska publicera på och klicka sedan på Tillåt.
   
5. Kopiera webhook-URL:en och öppna den airfocus-arbetsyta som du vill konfigurera uppdateringarna för.
   

Så här konfigurerar du din webhook i airfocus för att skicka meddelanden om händelseuppdateringar till Slack:

1. Klicka på ”Lägg till integrationer” i tilläggsfönstret.
   
2. I integrationsöversikten klickar du på ”Anslut” under ”Webhooks” -integrationen.
   
3. Ge din webhook ett namn (valfritt) och välj vilka händelser förfrågningarna ska utlösas för. → ”Status uppdaterad” för detta användningsfall.
   
4. I förfrågningsalternativen väljer du ”Slack markdown” som platshållarformat och ”POST” som metod. Klistra in webhook-webbadressen som du kopierade från Slack i URL-fältet.
   
5. För att ta emot korrekt formaterade Slack-meddelanden klistrar du in följande mall i brödfältet och trycker på uppdatera.

   •  

     {
      " block ": [
        {
          "type": "divider"
        },
        {
          " typ ": " section ",
          " text ": {
            " typ ": " mrkdwn ",
            " text ": "{{title|esc}}"
          },
          " tillbehör ": {
            " " " ",,
            "
            ": {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
            " värde ": " click_me_123 ",
            " url ": "{{url}}", " ": " knappåtgärd "
          }}
        },
        {
          " typ ": " section ",
          " text ": {
            " typ ": " mrkdwn ",
      " text ": "{{details|esc}}<span  
     
     
     
     translate="sv">55}}]}

      

6. Du kommer nu att få ett Slack-meddelande till kanalen du valde när något objekt i arbetsytan har ändrat status.
   

Få airfocus uppdateringar i Microsoft Team

Med funktionen Microsoft Team Workflows kan du konfigurera en webhook som skickar ett teammeddelande till en angiven kanal när objekt inom en viss airfocus arbetsyta uppdateras. För att göra detta måste du generera en webhook-URL i Microsoft Team och sedan konfigurera resten av integrationen i airfocus.

Skapa en webhook-URL i Microsoft Teams

Så här genererar du en webhook-URL i Microsoft Team:

1. Logga in på Microsoft-teamet.
2. Klicka på menyn med tre punkter i navigeringsmenyn längst till vänster.
3. Select arbetsflöde.
4. I sökfältet söker du ”webhook”.
5. Välj Lägg upp till en kanal när en webhook-förfrågan tas emot.
6. Skriv ett namn för ditt arbetsflöde (t.ex. "airfocus updates").
7. Klicka på Nästa.
8. Under "Detaljer" väljer du det specifika Team och den kanal där du vill att uppdateringarna ska visas.
9. Klicka på Lägg till arbetsflöde.
10. Kopiera POST-URL på bekräftelseskärmen.
    • Detta är webhook-URL:en som du behöver klistra in i airfocus.
11. Klicka på K lar för att slutföra installationen.

Konfigurera din webhook i airfocus

För att konfigurera din webhook i airfocus, följ dessa steg:

1. Öppna den airfocus -arbetsyta som du vill skicka uppdateringar till Microsoft Team för.
2. Klicka på Tillägg i det övre högra hörnet av arbetsytan.
3. Välj Lägg till integrationer.
4. Klicka på Anslut under ”Webhooks”.
5. Skriv ett namn för webhooken.
6. Under "Händelser" väljer du vilken typ av uppdateringar du vill skicka till Microsoft Team.
7. Under ”Platshållarformat” väljer du Markdown.
8. Under ”Metod” väljer du POST och klistra sedan in URL:en du genererade i Microsoft Team under ”URL”.
9. Välj + Lägg till rubrik.
10. Skriv ”Innehållstyp” under ”Rubriknamn”.
11. Under ”Rubrikvärde” skriver du ”application/json”.
    
12. För att ta emot korrekt formaterade Microsoft Team-meddelanden, klistra in följande mall i brödtextfältet.

    • {
       " typ ": " AdaptiveCard ",
       " $schema ": " http://adaptivecards.io/schemas/adaptive-card.json",
       " version ": " 1.4 ",
        "kropp": [
       {
       "typ": "Textblock",
       "text": "{{title}}",
       "storlek": "Medelstor",
       "vikt": "Djärvare",
       "omslag": sant
       },
       {
       "typ": "Textblock",
       "text": "{{details}}",
       "omslag": sant
       }
       ],
       "åtgärder": [
       {
       "typ": "Action.OpenUrl",
       "titel": "Öppna i airfocus",
       "webbadress": "{{url}}"
       }
       ]
       }

13. Klicka på Uppdat era längst ned till höger på sidan.

Du får nu uppdateringar till Microsoft Team-kanalen som du skapade i det första avsnittet.
 

Konfigurera HTTP-begäran - teknisk dokumentation

Metod

Den är inställd på POST som standard, men kan också ändras till GET eller PUT. Andra metoder stöds inte.

URL

• Bör inte vara tom
• kan bara börja med https://(andra scheman eller tomt schema stöds inte)
• bör ha ett offentligt domännamn med en välkänd toppdomän (IP-adresser stöds inte)

Rubriker

• Auktorisering stöds
• Innehållstyp stöds
• anpassade rubriker som börjar med x- stöds
• andra rubriker stöds inte

Kropp

Definierar en förfrågningstext för webhooken.

Kan innehålla text upp till 2000 tecken lång.

För att fylla i förfrågningstexten med meningsfulla händelsedata tillhandahåller vi ett gäng platshållare som vår server ersätter med händelsedata innan begäran skickas.

Platshållarformat

Anger hur platshållare med RichText-typ ska förrenderas av vår server. Till exempel kan {{title}} platshållare innehålla en sträng som ”John uppdaterade fälteti ketter på objekt Fi xa knappen” som innehåller viss formaterad text som fet, kursiv, etc, och därför anger platshållarformatet i vilken specifik syntax denna formatering ska omvandlas. Tillgängliga format:

Platshållare

Datamodeller

Modell för händelsenyttolast

Ett objekt på översta nivån, producerat för varje händelse. Den innehåller data om händelsen samt inbäddade grundläggande data om alla enheter som är relaterade till denna händelse.

Händelsemodell

Grundläggande uppgifter om evenemanget

EventInitiator-modell

Information om vem som initierade denna händelse. I de flesta fall definieras användar-ID. Det är också möjligt att det kommer att finnas både userID och IntegrationId definierade - t.ex. om en användare tryckte på knappen ”synkronisera integration” som sedan skapade händelsen.

EventEmbedd-modell

Ytterligare data om händelsen - mestadels namn på objekt/arbetsutrymmen/fält/etc som är relaterade till denna händelse.

TeamInfo-modell

UserInfo-modell

AppInfo-modell

WorkspaceInfo-modell

IntegrationInfo-modell

StatusInfo-modell

ItemInfo-modell

EventData-modell

EventData är en fackföreningstyp - det kan någon av de angivna typerna:

Skapat Dim

UppdateraDiem

Ge feedback på den här artikeln