Integrare airfocus con Webhook

Vantaggi dell'uso dei webhook

I Webhook permettono a airfocus e ad altre app di lavorare insieme facilmente e in tempo reale. Questo significa che aggiornamenti e notifiche avvengono rapidamente senza bisogno di app aggiuntive o di programmazione complicata.

Configurazione iniziale di un nuovo webhook

Crea un nuovo spazio di lavoro in airfocusoppure seleziona quello in cui vorresti creare un nuovo webhook.

Requisiti:

• Permessi "completi" sullo spazio di lavoro in cui vuoi configurare il webhook.
• Abbonamento a pagamento a un piano Professional o Aziendale.
• Conoscenze tecniche per una corretta configurazione.

Puoi aggiungere più webhook a un dato spazio di lavoro (ad esempio a diversi canali Slack per diversi pubblici di stakeholder).

Per farlo, vai semplicemente nella sezione Estensioni all'interno del tuo spazio di lavoro, clicca su "Aggiungi integrazioni" e "Connetti" sotto Webhook.

Poi, assegna al tuo webhook un nome (opzionale) e seleziona per quali eventi le richieste devono essere attivate.

Nelle opzioni di richiesta, scegli il formato segnaposto e il metodo e incolla l'URL del tuo webhook nel campo URL. Puoi anche aggiungere intestazioni alle tue richieste se necessario.

Opzionalmente puoi anche configurare il corpo della tua richiesta nel formato segnaposto scelto sopra.

{
 "blocchi": [
   {
     "type": "divider"
   },
   {
     "tipo": "sezione",
     "testo": {
       "tipo": "mrkdwn",
       "testo": "{{title|esc}}"
     },
     "accessorio": {
       "tipo": "pulsante",
       "testo": {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
       "valore": "click_me_123",
       "URL": "{{url}}",
       "action_id": "azione a pulsante"
     }
   },
   {
     "tipo": "sezione",
     "testo": {
       "tipo": "mrkdwn",
       "testo": "{{details|esc}}"
     }
   }
 ]
}

Per una documentazione dettagliata delle opzioni di personalizzazione dei tuoi webhook, leggi la seguente sezione.

Caso d'uso - ricevi notifiche Slack per aggiornamenti airfocus

Per questo caso d'uso, il nostro obiettivo è configurare un webhook che invii un messaggio Slack a un canale a nostra scelta ogni volta che un elemento dello spazio di lavoro per cui configuriamo il webhook viene aggiornato.

Per farlo, dobbiamo configurare un'app Slack per generare un URL webhook e poi configurare il resto dell'integrazione in airfocus.

Come creare un URL webhook per il tuo canale Slack:

1. Crea una nuova app Slack nello spazio di lavoro Slack dove vuoi ricevere le notifiche di airfocus.
   
   
2. Nella pagina Funzionalità, attiva l'opzione Attiva webhook in arrivo .
   
3. Fare clic su Aggiungi nuovo webhook all'area di lavoro.
   
4. Scegli un canale su cui l'app pubblicherà, poi clicca su Consenti.
   
5. Copia l'URL del webhook e apri il airfocus spazio di lavoro per cui vuoi configurare gli aggiornamenti.
   

Come configurare il tuo webhook in airfocus per inviare notifiche di aggiornamento degli eventi a Slack:

1. Nel popover delle estensioni, clicca su "Aggiungi integrazioni".
   
2. Nella panoramica delle integrazioni, clicca su "Connetti" sotto l'integrazione "Webhooks".
   
3. Dai un nome al tuo webhook (opzionale) e seleziona quali eventi devono essere attivate le richieste. → "Stato aggiornato" per questo caso d'uso.
   
4. Nelle opzioni di richiesta, seleziona "Slack markdown" come formato provvisorio e "POST" come metodo. Ora incolla l'URL del webhook che hai copiato da Slack nel campo URL.
   
5. Per ricevere messaggi Slack formattati correttamente, incolla il seguente Modello nel campo della carrozzeria e premi aggiorna.

   •  

     {
      "blocchi": [
        {
          "type": "divider"
        },
        {
          "tipo": "sezione",
          "testo": {
            "tipo": "mrkdwn",
            "testo": "{{title|esc}}"
          },
          "accessorio": {
            "tipo": "pulsante",
            "testo": {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
            "valore": "click_me_123",
            "URL": "{{url}}",
            "action_id": "azione a pulsante"
          }
        },
        {
          "tipo": "sezione",
          "testo": {
            "tipo": "mrkdwn",
            "testo": "{{details|esc}}"
          }
        }
      ]
     }

      

6. Ora riceverai un messaggio Slack al canale scelto quando un elemento nell'area di lavoro ha cambiato il suo Stato.
   

Ricevi aggiornamenti airfocus su Microsoft Team

La funzione Microsoft Team Workflows ti permette di configurare un webhook che invia un messaggio Team a un canale designato quando vengono aggiornati elementi all'interno di un determinato airfocus workspace. Per farlo, dovrai generare un URL webhook su Microsoft Team e poi configurare il resto dell'integrazione in airfocus.

Crea un URL di webhook in Microsoft Team

Per generare un URL di webhook in Microsoft Team, segui questi passaggi:

1. Accedi a Microsoft Team.
2. Clicca sul menu a tre punti nel menu di navigazione in estrema sinistra.
3. Select workflow.
4. Nella barra di ricerca, cerca "webhook".
5. Seleziona Pubblica su un canale quando ricevi una richiesta di webhook.
6. Digita un nome per il tuo workflow (ad esempio, "aggiornamentiairfocus ").
7. Clicca su Next.
8. Sotto "Dettagli", seleziona il Team e il Canale specifici dove vuoi che appaiono gli aggiornamenti.
9. Clicca su Aggiungi workflow.
10. Nella schermata di conferma, copia l'URL del POST.
    • Questo è l'URL del webhook che dovrai incollare in airfocus.
11. Clicca su Finito per finalizzare la configurazione.

Configura il tuo webhook in airfocus

Per configurare il tuo webhook in airfocus, segui questi passaggi:

1. Apri il airfocus spazio di lavoro per cui vuoi inviare aggiornamenti a Microsoft Team.
2. Clicca su Estensioni dall'angolo in alto a destra dello spazio di lavoro.
3. Seleziona Aggiungi integrazioni.
4. Sotto "Webhooks", clicca su Connetti.
5. Scrivi un nome per il webhook.
6. Sotto "eventi", seleziona che tipo di aggiornamenti vuoi inviare a Microsoft Team.
7. Sotto "Formato segnaposto", seleziona Markdown.
8. Sotto "Metodo", seleziona POST e poi incolla l'URL che hai generato in Microsoft Team sotto "URL".
9. Seleziona + Aggiungi intestare.
10. Sotto "Nome intestazione", digita "Content-Type".
11. Sotto "Header value", digita "application/json".
    
12. Per ricevere messaggi Microsoft Team formattati correttamente, incolla il seguente Modello nel campo corpo.

    • {
        "tipo": "AdaptiveCard",
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
        "versione": "1.4",
        "corpo": [
          {
            "type": "TextBlock",
            "testo": "{{title}}",
            "dimensione": "Media",
            "peso": "Più audaci",
            "Avvolgere": vero
          },
          {
            "type": "TextBlock",
            "testo": "{{details}}",
            "Avvolgere": vero
          }
        ],
        "azioni": [
          {
            "type": "Action.OpenUrl",
            "titolo": "Apri in airfocus",
            "URL": "{{url}}"
          }
        ]
      }

13. Clicca su Aggiorna dall'angolo in basso a destra della pagina.

Ora riceverai aggiornamenti sul canale Microsoft Team che hai impostato nella prima sezione.
 

Configurazione della richiesta HTTP - documentazione tecnica

Metodo

È impostato su POST di default, ma può anche essere cambiato in GET o PUT. Altri metodi non sono supportati.

URL

• Non dovrebbe essere vuoto
• può iniziare solo con https:// (altri schemi o schemi vuoti non sono supportati)
• dovrebbe avere un nome di dominio pubblico con un dominio di alto livello ben noto (gli IP non sono supportati)

Intestazioni

• L'autorizzazione è supportata
• È supportato il tipo di contenuto
• Sono supportate le intestazioni personalizzate che iniziano con x-
• Qualsiasi altra intestazione non è supportata

Corpo

Definisce il corpo della richiesta del webhook.

Può contenere qualsiasi testo fino a 2000 caratteri.

Per completare il corpo della richiesta con dati eventi significativi, forniamo una serie di segnaposto che il nostro server sostituisce con dati eventi prima di inviare la richiesta.

Formato segnaposto

Specifica come i segnaposto con tipo RichText devono essere pre-renderizzati dal nostro server. Ad esempio, il segnaposto {{title}} può contenere una stringa come "John ha aggiornato le etichette dei campi sull'elemento Correggi il pulsante " che contiene una formattazione RTF come grassetto, corsivo, ecc. e pertanto il formato del segnaposto specifica in quale sintassi specifica questa formattazione deve essere trasformata. Formati disponibili:

Segnaposto

Modelli di Dati

Modello di carico utile eventi

Un oggetto di livello superiore, prodotto per ogni eventi. Contiene dati sugli eventi così come dati di base incorporati su tutte le entità correlate a questo evento.

Modello eventi

Dati di base sugli eventi

Modello EventInitiator

Informazioni su chi ha avviato questo evento. Nella maggior parte dei casi l'userID sarà definito. È anche possibile che vengano definiti sia userId che integrationId - ad esempio se un utente preme il pulsante "sincronizza integrazione" che produce l'eventi.

Modello EventEmbed

Dati aggiuntivi sull'evento - principalmente nomi di elementi/workspace/campi/ecc. che sono correlati a questo eventoi.

Modello TeamInfo

Modello UserInfo

Modello AppInfo

Modello WorkspaceInfo

Modello IntegrationInfo

Modello StatusInfo

Modello ItemInfo

Modello EventData

EventData è un tipo unione - può essere uno dei tipi specificati:

Elemento creato

AggiornatoArticolo

Dai un feedback su questo articolo