Airfocus integreren met Webhooks

Voordelen van het gebruik van webhooks

Webhooks laten airfocus en andere apps eenvoudig en in real-time samenwerken. Dit betekent dat updates en meldingen snel gebeuren zonder dat je extra apps of ingewikkelde codering nodig hebt.

Eerste opstelling van een nieuwe webhook

Maak een nieuwe werkruimte aan in Airfocus, of selecteer degene waarin je een nieuwe webhook wilt maken.

Vereisten:

• "Full" Toestemmingen naar de werkruimte waar ik de webhook wil opzetten.
• Betaald abonnement op professioneel of Enterprise abonnement.
• Technische kennis voor de juiste configuratie.

je kan meerdere webhooks toevoegen aan een bepaald werkruimte (bijvoorbeeld aan verschillende Slack kanalen voor verschillende Stakeholder-doelgroepen).

Om dat te doen, ga je gewoon naar de sectie Extensies binnen jouw werkruimte, klik je op "Add integratie" en "Connect" onder Webhook.

Geef vervolgens jouw webhook een naam (optioneel) en selecteer voor welke gebeurtenis de verzoeken getriggerd moeten worden.

Kies in de verzoekopties het tijdelijke formaat en methode en plak jouw webhook URL in het URL-veld. JE kan ook headers toevoegen aan jouw verzoeken indien nodig.

Optioneel kan je ook het lichaam van jouw request configureren in het hierboven gekozen tijdelijke formaat.

{
 "blokken": [
   {
     "type": "divider"
   },
   {
     "type": "sectie",
     "tekst": {
       "type": "mrkdwn",
       "tekst": "{{title|esc}}"
     },
     "accessoire": {
       "type": "knop",
       "tekst": {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
       "waarde": "click_me_123",
       "url": "{{url}}",
       "action_id": "knop-actie"
     }
   },
   {
     "type": "sectie",
     "tekst": {
       "type": "mrkdwn",
       "tekst": "{{details|esc}}"
     }
   }
 ]
}

Voor gedetailleerde documentatie van aanpassingsopties voor jouw webhooks lees de volgende sectie.

Gebruik - ontvang Slack-meldingen voor AirFocus-updates

Voor dit gebruiksgeval is ons doel om een webhook te configureren die elke keer dat een item van de werkruimte waarvoor we de webhook configureren zijn status krijgt een Slack-bericht naar een kanaal naar keuze stuurt.

Om dat te doen, moeten we een Slack-app instellen om een webhook-URL te genereren en vervolgens de rest van de integratie in Airfocus configureren.

Hoe maak je een webhook-URL aan naar jouw Slack kanaal:

1. Maak een nieuwe Slack-app aan in de Slack-werkruimte waar je de AirFocus-meldingen wilt ontvangen.
   
   
2. Zet vanaf de pagina Functies de optie Inkomende Webhooks Activeren in.
   
3. Klik op Voeg nieuwe webhook toe aan werkruimte.
   
4. Kies een kanaal waar de app op zal posten en klik dan op Toestaan.
   
5. Kopieer de webhook-URL en open de airfocus-werkruimte waarvoor je de updates wilt opstellen.
   

Hoe configureer je jouw webhook in Airfocus om gebeurtenis-updatemeldingen naar Slackte sturen:

1. Klik in de popover van extensies op "Add integratie".
   
2. Klik in het integratieoverzicht op "Verbinden" onder de integratie "Webhooks".
   
3. Geef jouw webhook een naam (optioneel) en selecteer voor welke gebeurtenis de verzoeken getriggerd moeten worden. → "Status bijgewerkt" voor dit gebruiksgeval.
   
4. Selecteer in de verzoekopties "Slack markdown" als plaatsvervangend formaat en "POST" als methode. Plak nu de webhook-URL die je uit Slack hebt gekopieerd in het URL-veld.
   
5. Om correct geformatteerd Slack bericht te ontvangen, plak je het volgende sjabloon in het hoofdtekstveld en druk je op update.

   •  

     {
      "blokken": [
        {
          "type": "divider"
        },
        {
          "type": "sectie",
          "tekst": {
            "type": "mrkdwn",
            "tekst": "{{title|esc}}"
          },
          "accessoire": {
            "type": "knop",
            "tekst": {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
            "waarde": "click_me_123",
            "url": "{{url}}",
            "action_id": "knop-actie"
          }
        },
        {
          "type": "sectie",
          "tekst": {
            "type": "mrkdwn",
            "tekst": "{{details|esc}}"
          }
        }
      ]
     }

      

6. JE ontvangt nu een Slack bericht aan het kanaal dat je heeft gekozen wanneer een item in de werkruimte zijn Status heeft gewijzigd.
   

Ontvang airfocus updates in Microsoft Teams

De Microsoft Teams workflowfunctie stelt je in staat een webhook te configureren die een Teambericht naar een aangewezen kanaal stuurt wanneer items binnen een bepaald airfocus werkruimte worden bijgewerkt. Om dit te doen, moet ik een webhook-URL op Microsoft Teams genereren en vervolgens de rest van de integratie configureren in airfocus.

Maak een webhook-URL aan in Microsoft Teams

Om een webhook-URL in Microsoft Teamste genereren, volgen we deze stappen:

1. Log in bij Microsoft Teams.
2. Klik op het menu met drie puntjes in het navigatiemenu helemaal links.
3. Select workflow.
4. Zoek in de zoekbalk op "webhook".
5. Selecteer Plaatsen op een kanaal wanneer een webhook-verzoek wordt ontvangen.
6. Typ een naam in voor jouw workflow (bijv. "Airfocus updates").
7. Klik op Volgende.
8. Selecteer onder "Details" het specifieke Team en Kanaal waar je wilt dat de updates verschijnen.
9. Klik op Voeg workflowtoe.
10. Kopieer op het bevestigingsscherm de POST-URL.
    • Dit is de webhook-URL die je in airfocusmoet plakken.
11. Klik op Klaar om de setup af te ronden.

Configureer jouw webhook in airfocus

Om jouw webhook in airfocuste configureren, volg deze stappen:

1. Open de airfocus werkruimte waarvoor je updates naar Microsoft Teamswilt sturen.
2. Klik rechtsboven op Uitbreidingen in de werkruimte.
3. Selecteer Voeg integratie toe.
4. Klik onder "Webhooks" op Verbinden.
5. Typ een naam in voor de webhook.
6. Selecteer onder "gebeurtenis" welk soort updates ik naar Microsoft Teamswilt sturen.
7. Selecteer onder "Placeholder-formaat" Markdown.
8. Selecteer onder "Methode" POST en plak de URL die je in Microsoft Teams hebt gegenereerd onder "URL".
9. Selecteer + Voeg kop.
10. Onder "Header name" typ je "Content-Type".
11. Onder "Header value" typ je "applicatie/json".
    
12. Om correct geformatteerd Microsoft Teams bericht te ontvangen, plakt u het volgende sjabloon in het hoofdtekstveld.

    • {
        "type": "AdaptiveCard",
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
        "versie": "1.4",
        "lichaam": [
          {
            "type": "TextBlock",
            "tekst": "{{title}}",
            "grootte": "Medium",
            "gewicht": "Gedurfder",
            "Wrap": waar
          },
          {
            "type": "TextBlock",
            "tekst": "{{details}}",
            "Wrap": waar
          }
        ],
        "Acties": [
          {
            "type": "Action.OpenUrl",
            "titel": "Open in airfocus",
            "URL": "{{url}}"
          }
        ]
      }

13. Klik rechtsonder op de pagina op Updaten .

JE ontvangt nu updates over het Microsoft Teams kanaal dat JE in het eerste gedeelte heeft opgezet.
 

HTTP-verzoek configureren - technische documentatie

Methode

Het staat standaard op POST, maar kan ook worden gewijzigd naar GET of PUT. Andere methoden worden niet ondersteund.

URL

• Mag niet leeg zijn
• Kan alleen beginnen met https:// (andere schema's of lege schema's worden niet ondersteund)
• moet een publieke domeinnaam hebben met een bekend top-niveau-domein (IP's worden niet ondersteund)

Kopteksten

• Autorisatie wordt ondersteund
• Content-Type wordt ondersteund
• Aangepaste headers die beginnen met x- worden ondersteund
• andere headers worden niet ondersteund

Hoofdtekst

Definieert een request body van de webhook.

Kan elke tekst tot 2000 tekens lang bevatten.

Om het verzoeklichaam in te vullen met betekenisvolle gebeurtenis-data, leveren we een aantal tijdelijke elementen die onze server vervangt door gebeurtenis-data voordat het verzoek wordt verzonden.

Plaatsvervangerformaat

Geeft aan hoe de placeholders met RichText-type vooraf door onze server moeten worden gerenderd. Bijvoorbeeld {{title}} , een tijdelijke tekst kan een string bevatten zoals "John updated field Labels on item Fix the knop" die wat rich-text opmaak bevat zoals vetgedrukt, cursief, enzovoort, en daarom specificeert het placeholderformaat in welke specifieke syntaxis deze opmaak moet worden getransformeerd. Beschikbare formaten:

Plaatsvervangers

Datamodellen

gebeurtenis Payload model

Een object op topniveau, geproduceerd voor elke gebeurtenis. Het bevat gegevens over de gebeurtenis evenals ingebedde basisgegevens over alle entiteiten die met deze gebeurtenis te maken hebben.

Gebeurtenismodel

Basisgegevens over de gebeurtenis

EventInitiator-model

Informatie over wie deze gebeurtenis heeft geïnitieerd. In de meeste gevallen wordt de userId gedefinieerd. Het is ook mogelijk dat er zowel userId als integrationId gedefinieerd zijn - bijvoorbeeld als een gebruiker op de knop "synchronise integratie" drukt, wat dan de gebeurtenis produceert.

EventEmbed-model

Aanvullende gegevens over de gebeurtenis - voornamelijk namen van items/werkruimte/velden/etc. die met deze gebeurtenis te maken hebben.

TeamInfo-model

UserInfo-model

AppInfo-model

WorkspaceInfo-model

IntegratieInfo-model

StatusInfo-model

ItemInfo-model

EventData-model

EventData is een unietype - het kan een van de gespecificeerde types zijn:

CreatedItem

BijgewerktItem

Feedback geven over dit artikel