AirfocusとWebhookを統合する

ウェブフック使用の利点

Webhook を使用すると、airfocus と他のアプリを簡単にリアルタイムで連携させることができます。つまり、追加のアプリや複雑なコーディングを必要とせずに、更新と通知が迅速に行われるということです。

新しいウェブフックの初期設定

AirFocusで新しいワークスペースを作成するか、新しいウェブフックを作りたいワークスペースを選択してください。

要件:

• Webhookを設定したいワークスペースに対して「完全な」権限を割り当てます。
• プロフェッショナルまたはエンタープライズプランの有料サブスクリプション。
• 適切な構成のための技術的知識。

複数のウェブフックを特定のワークスペースに追加できます(例:異なるステークホルダーのオーディエンス向けに異なるSlackチャンネルに)。

その手順は、ワークスペース内の拡張機能セクションに行き、Webhookの「 Add integlation」 と 「Connect」 をクリックしてください。

次に、ウェブフックに 名前 (任意)を付け、どの イベント でリクエストをトリガーするかを選択します。

リクエストオプションで プレースホルダー形式とメソッド を選択し、 ウェブフックのURL をURLフィールドに貼り付けます。必要に応じてリクエストに ヘッダー を追加することもできます。

オプションで、リクエストの本文を上記で選択したプレースホルダー形式で設定することもできます。

{
 「ブロック」:[
   {
     "type": "divider"
   },
   {
     「type」: 「section」
     「テキスト」:{
       「type」:「mrkdwn」
       「テキスト」:「{{title|esc}}」
     },
     「アクセサリー」:{
       「type」: 「ボタン」、
       「テキスト」: {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
       「値」:「click_me_123」
       "URL": "{{url}}",
       「action_id」:「ボタンアクション」
     }
   },
   {
     「type」: 「section」
     「テキスト」:{
       「type」:「mrkdwn」
       「テキスト」:「{{details|esc}}」
     }
   }
 ]
}

ウェブフックのカスタマイズオプションの詳細ドキュメントについては、以下のセクションをお読みください。

ユースケース - AirFocusのアップデートに関するSlack通知を受け取る

このユースケースでは、Webhookを設定したワークスペースのアイテムがステータス更新されるたびに、Slackメッセージを選択したチャネルに送信するWebhookを設定することが目標です。

そのためには、ウェブフックのURLを生成する Slack アプリを設定し、その後、残りのインテグレーションをAirFocusで設定する必要があります。

Slack チャンネルへの Webhook URL を作成する方法:

1. airfocus 通知を受信する Slack ワークスペースに新しい Slack アプリを作成します。
   
   
2. 機能ページから「 着信Webhooksの有効化 」オプションをオンにしてください。
   
3. 「ワークスペースに新しい Webhook を追加」をクリックします。
   
4. アプリが投稿するチャンネルを選んでから 「許可」をクリックします。
   
5. webhookのURLをコピー し、アップデートを設定したいairfocusワークスペースを開きます。
   

Slack にイベント更新通知を送信するために、airfocus で webhook を設定する方法:

1. 拡張機能のポップオーバーで「Add インテグレーション」をクリックしてください。
   
2. インテグレーションの概要で、「Webhooks」インテグレーションの下の「Connect」をクリックしてください。
   
3. ウェブフックに名前(任意)を付け、どのイベントでリクエストをトリガーするかを選択します。このユースケースでは「ステータス更新済み」→。
   
4. リクエストオプションで、プレースホルダー形式として「Slack markdown」を選び、「POST」をメソッドとして選択します。次に、SlackからコピーしたウェブフックのURLをURLフィールドに貼り付けます。
   
5. 正しくフォーマットされたSlackメッセージを受け取るには、以下のテンプレートを本文欄に貼り付けて「更新」を押してください。

   •  

     {
      「ブロック」:[
        {
          "type": "divider"
        },
        {
          「type」: 「section」
          「テキスト」:{
            「type」:「mrkdwn」
            「テキスト」:「{{title|esc}}」
          },
          「アクセサリー」:{
            「type」: 「ボタン」、
            「テキスト」: {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
            「値」:「click_me_123」
            "URL": "{{url}}",
            「action_id」:「ボタンアクション」
          }
        },
        {
          「type」: 「section」
          「テキスト」:{
            「type」:「mrkdwn」
            「テキスト」:「{{details|esc}}」
          }
        }
      ]
     }

      

6. ワークスペース内のアイテムのステータスが変更された際に、選択したチャンネルにSlackメッセージが届きます。
   

airfocus最新情報をお届けMicrosoft Teams

Microsoft Teams 業務フロー機能は、特定のairfocusワークスペース内のアイテムが更新された際に指定されたチャネルにチームメッセージを送信するウェブフックを設定できます。これを行うには、 Microsoft Teams でウェブフックURLを作成し、その後インテグレーションの残りを設定する必要があります airfocus。

Microsoft TeamsでウェブフックURLを作成する

Microsoft TeamsでウェブフックURLを生成するには、以下の手順をフォローしてください:

1. Microsoft Teamsにログインしてください。
2. 左側のナビゲーション メニューで 3 ドットメニューをクリックします。
3. Select 業務フロー.
4. 検索バーに「webhook」と入力して検索してください。
5. 「Webhookリクエストを受信したときにチャネルに投稿する」を選択します。
6. 業務フローの名前を入力します (例: 「Airfocus アップデート」)。
7. [次へ] をクリックします。
8. 「詳細」で、更新情報を表示させたい特定のチームとチャネルを選択してください。
9. 「業務フローの追加」をクリックします。
10. 確認画面で、POST URLをコピーしてください。
    • これは、 airfocusに貼り付ける必要があるウェブフック URL です。
11. 「完了」をクリックして設定を完了してください。

ウェブフックを設定 airfocus

airfocusでウェブフックを設定するには、以下の手順をフォローしてください:

1. アップデートを送信したいプラットフォーム airfocus を開きます Microsoft Teams。
2. ワークスペースの右上から 拡張機能 をクリックします。
3. 「 Add インテグレーション」を選択します。
4. 「Webhooks」の下から 「Connect」をクリックします。
5. ウェブフックの名前を入力してください。
6. 「イベント」で、Microsoft Teamsに送る更新の種類を選択してください。
7. 「プレースホルダーフォーマット」で Markdownを選択してください。
8. 「メソッド」で POST を選択し、Microsoft Teamsで作成したURLを「URL」の下に貼り付けます。
9. + ヘッダーを追加を選択します。
10. 「ヘッダー名」の下に「Content-Type」と入力してください。
11. 「ヘッダー値」の下に「アプリケーション/json」と入力してください。
    
12. 適切なフォーマットのMicrosoft Teamsメッセージを受け取るには、以下のテンプレートを本文欄に貼り付けてください。

    • {
        「タイプ」:「AdaptiveCard」
        「$schema」:「http://adaptivecards.io/schemas/adaptive-card.json」
        「バージョン」:「1.4」「ボディ」:[
          {
            「type」:「TextBlock」、
            「テキスト」:「{{title}}」、
            「サイズ」:「ミディアム」
            「重さ」:「より大胆」
            「ラップ」:真
          },
          {
            「type」:「TextBlock」、
            「テキスト」:「{{details}}」、
            「ラップ」:真
          }
        ],
        「行動」:[
          {
            "type": "Action.OpenUrl",
            「タイトル」:「 airfocusに開け」
            "URL": "{{url}}"
          }
        ]
      }

13. ページ右下から 「アップデート 」をクリックしてください。

これから、最初のセクションで設定したMicrosoft Teamsチャンネルの更新情報を受け取ることができます。
 

HTTPリクエストの設定 - 技術文書

方法

デフォルトではPOSTに設定されていますが、GETやPUTに変更することも可能です。他の方法はサポートされていません。

URL

• 空っぽであってはいけません
• https:// でしかスタートできません(他のスキームや空スキームはサポートされません)
• パブリックドメイン名と 、よく知られたトップレベルドメイン (IPはサポートされていません)を持つべきです。

ヘッダー

• 承認は支持されています
• コンテンツタイプはサポートされています
• スタートをx-で行うカスタムヘッダーもサポートされています
• それ以外のヘッダーはサポートされていません

本文

Webhook のリクエスト本文を定義します。

最大2000文字までの任意のテキストを含めることができます。

リクエスト本体に意味のあるイベントデータを埋めるために、サーバーがリクエストを送信する前にそれらをイベントデータに置き換える多数のプレースホルダーを提供しています。

プレースホルダー形式

RichTextタイプのプレースホルダーをサーバーで事前レンダリングする方法を指定します。例えば、プレースホルダー {{title}} 「John updated field Labels on item Fix the button」のような文字列を含めることができ、これは太字や斜体などのリッチテキスト書式を含むため、プレースホルダー形式はどの構文で変換すべきかを指定します。 利用可能なフォーマット:

プレースホルダー

データモデル

イベントペイロードモデル

各イベントごとに生成されるトップレベルのオブジェクト。このイベントに関するデータと、このイベントに関連するすべての実体に関する基本的な埋め込みデータが含まれています。

イベントモデル

イベントに関する基本データ

イベントイニシエータモデル

このイベントを開始した人に関する情報。ほとんどの場合、userId が定義されます。userId とintegrationId の両方が定義される可能性もあります。たとえば、ユーザーが「同期統合」ボタンを押してイベントが生成された場合などです。

EventEmbed モデル

イベントに関する追加データ、主にこのイベントに関連するアイテム名、ワークスペース名、フィールド名などです。

TeamInfo モデル

ユーザー情報モデル

AppInfo モデル

WorkspaceInfo モデル

IntegrationInfo モデル

StatusInfo モデル

ItemInfo モデル

EventData モデル

EventDataはユニオン型であり、指定されたタイプのいずれかに分類できます。

作成されたアイテム

更新済みアイテム

この記事へのフィードバックをお寄せください