プロジェクト Webhook の構成

最後の更新
PDFとして保存

目的

プロジェクト内の１つ以上の Procore API リソースが変更されたときに通知を受け取るように Webhook 機能を構成します。

背景

Webhook 機能を使用すると、第三者の開発者やインテグレータは、作成、更新、または削除アクションが発生したときに通知を受け取りたい１つ以上の Procore API リソースを指定できます。Webhook 機能を構成するためのユーザーインターフェイスは、Procore のプロジェクトの [管理者] ツールを通じて利用できます。

Webhook 機能の利点は次のとおりです。

リソースの変更を判断するために第三者との統合でロジック/コードをポーリングする必要がなくなりました。
ポーリングを非同期更新に置き換えることによりパフォーマンスが向上しました
リソースが変更された場合にのみコードを実行する必要があるため、効率が向上します。
Procore API のレート制限の上限を超えるリスクの軽減

考慮すべきこと

必要なユーザー権限:
- プロジェクトの管理者ツールの「管理者」。
開発者情報:
- Webhook を適切にサポートするためのアプリケーションまたは統合の開発については、開発者ポータルの「Webhook の概要」および「Webhook API の使用」ガイドを参照してください。

ステップ

プロジェクトの [管理者] ツールに移動します。
これにより、「一般的なプロジェクト情報」ページが表示されます。
サイドバーの「プロジェクト設定」メニューで、 [Webhooks] をクリックします。

これにより、「Webhook」構成ページが開きます。このページには、ウェブサーバーの URL を入力するための [通知エンドポイント] フィールドと、通知を受け取りたいリソースおよび対応する変更アクションを選択するための [リソースグリッド] が含まれています。

[通知エンドポイント] フィールドに、Procore からの POST リクエストを処理するウェブサーバー上のエンドポイントの URL を入力します。
(オプション) [認証ヘッダー] フィールドに、Procore からの POST リクエストのヘッダーに配置する認証トークンを入力します。このフィールドは、任意の認可ヘッダー情報を定義するために使用できますが、最も一般的には、構文 <type> <credential> を使用して資格認定認証情報を指定するために使用されます。<type> は認可の種類 (「ベーシック」、「トークン」、「ベアラ」など)で、<credential> はトークンの値です。たとえば、このフィールドの有効な入力データはベーシック c3a24b8208ac5199d083d54a1234e94b8864 になります。
[エンドポイントの保存] をクリックします。[通知エンドポイント] フィールドに有効な正しい形式のアドレスを入力すると、画面の上部に成功を示す緑色のバナーが表示されます。入力した URL に問題がある場合は、考えられる問題を説明する警告バナーが表示されます。
[リソースグリッド] で、対応する通知を受け取りたいリソースの「作成」、「更新」、および「削除」アクションを選択します。アクションの選択は選択するとすぐに有効になり、変更を「提出」する必要はないことに注意してください。

注: Webhook を構成するときは、通知を受け取りたいリソース/アクションを特定しているだけであることに留意してください。リソースに実際の変更が発生した場合にのみ、通知を受け取ります。

Webhook の配信

通知エンドポイントへの [Webhook 配信] の実行記録は、プロジェクト Webhook ページの下部で確認できます。[配信] セクションでは、Procore が通知サーバーに送信した (または送信しようとした) イベントのステータスをすぐに確認できます。既定では、成功した配信と失敗した配信の両方が表示されます。[失敗のみを表示] チェックボックスを使用して、表示を絞り込み、失敗した配信のみを表示することができます。

最新の配信は「配信」セクションの上部に表示されます。配信データをクリックすると、リクエストペイロード、回答ヘッダー、および回答本文の詳細が表示されます。

配信記録の表示はページ分割されており、一度に最大 25 件の配信が表示されます。「その他の配信」をクリックすると、次の 25 件の配信セットが表示されます。

監視と警報

通知エンドポイントサーバーの適切な監視を設定して、ダウンタイムやその他のパフォーマンス関連の問題が確実に特定され、信頼できるアラームシステムを通じてタイムリーに通知されるようにすることを強くお勧めします。Datadog、New Relic など、この目的を果たすことができる多くの商業監視システムが利用可能です。これらのサービスは、構成可能なチャート、グラフ、リアルタイムアナリティクスを通じてシステムの健全性を簡単に視覚化できる堅牢な監視機能を提供します。これらのサービスには、問題が発生したときにすぐに通知されるように、組み込みアラートも提供されます。

以下もご覧ください

会社レベルでの Webhook の構成については、「会社の Webhook の構成」を参照してください。
プロジェクト Webhook 構成はプロジェクトテンプレートでサポートされています。詳細については、「プロジェクトテンプレートの構成」を参照してください。