はじめに
SharePointでドキュメントが更新されたら、すぐ検知し特定アクションを行いたい場合があります。
Webhookの仕組みを用いて、SharePointにイベントトリガーを設定し、イベント通知するフローを、
シーケンス図を使って理解してみました。
Webhook(ウェブフック)とは
- Webアプリケーションで特定のイベントが発生したら別のWebアプリケーションに通知を発行する仕組み
- Web開発でカスタムコールバックを用いてWebアプリケーションの動作を追加または変更するための方法
- リクエストは、HTTP POSTリクエストとして行われる
- フォーマットには通常JSONが利用される
SharePoint Webhookとは
※ 引用元: https://learn.microsoft.com/ja-jp/sharepoint/dev/apis/webhooks/overview-sharepoint-webhooks
- SharePointで発生した特定イベントの通知を受け取るための仕組み
- イベントがトリガーされると、SharePointからHTTP POSTペイロードが送信される
- Webhookは標準のHTTP サービス(Web API)で、簡単に使用することができる
- WebhookはSharePointリストアイテムに対してのみ有効
- SharePointリストやドキュメントライブラリのリストアイテムの変更イベントを扱う
まずは、Webhook作成フロー
つぎは、Webhook通知フロー
おわりに
SharePointのWebhook仕組みをシーケンス図で理解しました。
次回は、Webhookレシーバーの設定方法を検証してみます。
お楽しみに。