プロジェクト Webhook の構成

目的

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

背景

Webhook は、特定のイベントが発生したときに、あるアプリケーションから別のアプリケーションにリアルタイムで送信される自動メッセージまたは HTTP リクエストであり、定期的なポーリングや手動リクエストを必要とせずにリアルタイムのデータ更新を可能にします。Webhook は、アプリケーション間でのデータ転送プロセスを自動化するため、あるアプリケーションが別のアプリケーションからの更新を常にチェックする必要がなくなります。

Procore のコンテキストでは、Webhook 機能を使用すると、会社およびプロジェクト管理者は、作成、更新、または削除アクションが発生したときに、サードパーティの開発者やインテグレータが 1 つ以上の Procore API リソースのイベント通知をサブスクライブできるようになります。たとえば、サードパーティの情報提供依頼との統合では、Procore で新しい情報提供依頼が作成されるたびに通知を受け取りたい場合があります。

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

Procore とサードパーティのアプリケーションおよびサービス間の即時通信を可能にします。Webhook は、アプリケーションが情報を要求するのを待つのではなく、イベントが発生するとすぐに Procore からデータをプッシュします。これにより、システムが常に最新の状態に保たれます。
特定のイベントが発生するたびにサードパーティアプリケーションでアクションをトリガーすることで、ワークフローの自動化を可能にします。
Webhook は、定期的なポーリングの必要性を排除することで、サーバーの負荷を軽減し、帯域幅を節約します。これにより、リソースをより効率的に使用できます。
ポーリングによって API リクエストの数を減らすと、特に大量のデータを処理するアプリケーションの場合、大幅なコスト削減につながる可能性があります。

考慮すべきこと

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

新しいフックの作成

プロジェクトレベルの管理者ツールに移動します。
[プロジェクト設定] で [ Webhooks] をクリックします。
[Webhook] ページで、[ フックの作成] をクリックします。

これにより、フックを構成するための多数のフィールドとコントロールを含む新しいフック構成ページが開きます。

エンドポイントの構成:

[エンドポイント URL ] - Webhook がトリガーされたときに Procore からの POST リクエストを処理するサードパーティ Web サーバー上のエンドポイントの URL を入力します。
認証ヘッダー (オプション) - Procore から送信される POST リクエストのヘッダーに配置する認証トークンを入力します。このフィールドは、任意の認可ヘッダー情報を定義するために使用できますが、最も一般的には、サードパーティサーバーの認証情報を指定するために使用されます。たとえば、このフィールドの有効な入力データは「ベーシック c3a24b8208ac5199d083d54a1234e94b8864」のようになります。
ペイロード形式 - サードパーティサービスに送信する REST API ペイロードのバージョンを選択します。サードパーティの開発者と協力して、どのペイロード形式が好ましいかを理解する必要があります。フックが作成されると、ペイロードのバージョンは変更できないことに注意してください。ペイロードのバージョンを変更する必要がある場合は、フックを削除して再作成する必要があります。詳細については、「Webhook ペイロードの形式」を参照してください

送信するイベントを選択します。

選択したイベントを表示:

選択した通知イベントを確認し、必要に応じて一部を削除できます。

Webhook イベントの表示

フックを作成して設定すると、Procore がサードパーティサービスに送信したイベントのステータスを表示できます。
[概要] セクションには、フックのステータスやその他の関連情報など、フックの概要が表示されます。

「イベント」セクションには、選択したフックのイベント履歴が表示されます。イベント履歴は 28 日間維持されます。

各イベントは、リソース名、リソース ID、イベントの種類、イベントの状態、および UTC のタイムスタンプによって識別されます。

「イベント・ステータス」に指定できる値は次のとおりです。

配信済み - イベントはサードパーティサービスに正常に配信されました。
破棄 - イベントは破棄されました。それ以上の配達の試みは行われません。
失敗 - イベントの配信に失敗しました。
Queued - イベントはサードパーティサービスへの配信のためにキューに入れられました。
再試行中 - イベントの配信が再試行されています。

「イベント」リストでは、さまざまなアクションを実行できます。

特定のリソースのイベントをリソース ID で検索します。
[リソース名] ドロップダウンを使用して、選択したリソースのイベントのみを表示します。
[イベントステータス]ドロップダウンを使用して、選択したイベントステータスのイベントのみを表示します。
「フィルター」ボタンを使用して、イベント・リストにカスタム・フィルターを作成します。
リスト内の個々のイベントをクリックすると、詳細が表示されます。

以下もご覧ください

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