受信 Webhook を作成する

[アーティクル]
02/23/2024

受信 Webhook を使用すると、外部アプリケーションは Microsoft Teams チャネルでコンテンツを共有できます。 Webhook は、追跡と通知を行うツールとして使用されます。 Webhook は、カード形式のメッセージを含む JSON ペイロードを送信する一意の URL を提供します。カードは、1 つの記事に関連するコンテンツとアクションを含むユーザーインターフェイスコンテナーです。カードは、次の機能で使用できます。

ボット
メッセージ拡張機能
コネクタ

注:

メッセージサイズの制限は 28 KB です。サイズが 28 KB を超えると、エラーが発生します。詳細については、「 Microsoft Teams の制限と仕様」を参照してください。
1 秒間に 4 つ以上の要求が行われた場合、クライアント接続は、ウィンドウが固定レートの間更新されるまで調整されます。指数バックオフを使用した再試行ロジックは、要求が 1 秒以内に制限を超える場合のレート制限を軽減できます。レート制限に達しないようにするには、「 HTTP 429 応答」を参照してください。

受信 Webhook の主な機能

次の表に、受信 Webhook の機能と説明を示します。

機能	説明
受信 Webhook を使用したアダプティブカード	アダプティブカードは、受信 Webhook を介して送信できます。詳細については、「受信 Webhookを使用してアダプティブカードを送信する」を参照してください。
アクション可能なメッセージングのサポート	アクション可能なメッセージカードは、Teams を含むすべての Microsoft 365 グループでサポートされています。カード経由でメッセージを送信する場合は、アクション可能なメッセージカード形式を使用する必要があります。詳細については、「従来のアクション可能なメッセージカードリファレンスとメッセージカードプレイグラウンド」を参照してください。
独立した HTTPS メッセージングのサポート	カードは、情報を明確かつ一貫して提供します。 HTTPS POST 要求を送信できるツールまたはフレームワークは、受信 Webhook を介して Teams にメッセージを送信できます。
Markdown のサポート	アクション可能なメッセージングカードのすべてのテキストフィールドで、基本的な Markdown がサポートされています。カードには HTML マークアップを使用しないでください。 HTML は無視され、プレーンテキストとして扱われます。
スコープ構成	受信 Webhook のスコープは、チャネルレベルで構成されます。
セキュリティで保護されたリソース定義	メッセージは JSON ペイロードとして書式設定されます。この宣言型メッセージング構造は、悪意のあるコードの挿入を防ぎます。

注:

Teams ボット、メッセージング拡張機能、受信 Webhook、およびBot Frameworkは、アダプティブカードをサポートします。 Adaptive Card は、Windows、Android、iOS などのすべてのプラットフォームで使用される、オープンなクロスカードプラットフォームフレームワークです。現時点では、 Teams コネクタはアダプティブカードをサポートしていません。ただし、Teams チャネルにアダプティブカードを投稿するフローを作成することはできます。
カードと Webhook の詳細については、「アダプティブカードと受信 Webhooks」を参照してください。

受信 Webhook を作成する

Teams チャネルに受信 Webhook を追加するには、次の手順に従います。

新しい Teams
クラシック Teams

新しい Teams クライアントで、[ Teams ] を選択し、受信 Webhook を追加するチャネルに移動します。
チャネル名の右側にある [ その他のオプション ] ••• を選択します。
[ チャネルの管理] を選択します。
[編集] を選択します。
受信 Webhookを検索し、[追加]選択します。

[受信 Webhook] ダイアログが表示されます。
[追加] を選択します。

注:

受信 Webhook を既に追加している場合は、[ 構成 ] オプションが表示されます。 [ 構成] を選択 して、受信 Webhook を作成します。
Webhook の名前を指定し、必要に応じてイメージをアップロードします。
[作成] を選択します。
ダイアログに存在する一意の Webhook URL をコピーして保存します。 URL はチャネルにマッピングされ、それを使用して Teams に情報を送信することができます。
[完了] を選択します。 Webhook は Teams チャネルで使用できるようになりました。

次のグラフィカル表現は、受信 Webhook を作成する手順を示しています。

グラフィカルな表現は、受信 Webhook を作成する手順を示しています。

重要

通知ボット Teams アプリは、受信 Webhook 以外の Teams Toolkit を使用して構築できます。同様に実行されますが、通知ボットの機能は高くなります。詳細については、「JavaScript または受信 Webhook 通知サンプルを使用して通知ボットを構築する」を参照してください。

Microsoft 365 グループの受信 Webhook またはコネクタを使用して、アクション可能なメッセージを作成して送信できます。詳細については、「メッセージの作成と送信」を参照してください。

注:

Teams で、[設定]>[メンバーのアクセス許可>メンバーがコネクタを作成、更新、削除できるようにする]を選択して、チームメンバーがコネクタを追加、変更、または削除できるようにします。

サンプルコードリファレンス

var adaptiveCardJson = @"{
  ""type"": ""message"",
  ""attachments"": [
    {
      ""contentType"": ""application/vnd.microsoft.card.adaptive"",
      ""content"": {
        ""type"": ""AdaptiveCard"",
        ""body"": [
          {
            ""type"": ""TextBlock"",
            ""text"": ""Message Text""
          }
        ],
        ""$schema"": ""http://adaptivecards.io/schemas/adaptive-card.json"",
        ""version"": ""1.0""
      }
    }
  ]
}";

var webhookUrl = "https://xxxxx.webhook.office.com/xxxxxxxxx";

var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var content = new StringContent(adaptiveCardJson, System.Text.Encoding.UTF8, "application/json");
var response = await client.PostAsync(webhookUrl, content);

サンプルコードリファレンス

var formatted_Card_Payload = {
        "type": "message",
        "attachments": [
            {
                "contentType": "application/vnd.microsoft.card.adaptive",
                "contentUrl": null,
                "content": {
                    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
                    "type": "AdaptiveCard",
                    "version": "1.2",
                    "body": [
                        {
                            "type": "TextBlock",
                            "text": "Submitted response:"+ response
                        }
                    ]
                }
            }
        ]
    }

var webhookUrl = "https://xxxxx.webhook.office.com/xxxxxxxxx";

axios.post(webhookUrl , formatted_Card_Payload )
    .then(res => {
        console.log(`statusCode: ${res.status}`)
        console.log(res)
    })
    .catch(error => {
        console.error(error)
    })