Webhook の操作
Webhookについて
重要: アクションの限定的なサポート 現在、Webhook は、単純なアクションまたは複合アクションとして、 オブジェクトの挿入 アクションのみをサポートしています。 今後のリリースでは、さらに多くのアクションのサポートが追加される予定です。 レコードの更新に関する暫定的な回避策については、「回避策: Webhook を使用してインシデントを更新する」を参照してください。
Webhook は、サードパーティ ツールで開始されたイベントによってトリガーされ、 給与責任者 エンドポイントに送信された受信メッセージを処理します。 受信メッセージ データは有効な JSON または XML である必要があります。
これは、最終的に複数の Webhook、エンドポイント、および認証方法をサポートできる新しい集中型 Webhook 機能です。 各 Webhook は、受信したデータの自動解析を可能にする変数を介してアクションに割り当てることができます。 この図は、高レベルのプロセスを示しています。

Webhook処理
受信した Webhook は 給与責任者 REST API によって処理されます。
- Webhook と URL を検証します。
- 受信メッセージ ヘッダーで宣言された形式タイプが本文の形式と一致するかどうかを検証します。 一致しない場合は、リクエストは拒否されます。
- 受信メッセージがシステムに指定された Webhook 制限を超えていないことを検証します。
- 送信者に応答コードを提供します。
詳細については、「 Webhook ログ」を参照してください。
JSON または XML データの解析
Webhook は、アクション用に構成された JSON および XML 修飾子を使用して、外部ツールと 給与責任者の間でデータを解析、変更、および使用します。 JSON の場合、受信データは有効な JSON オブジェクトである必要があります。
この解析プロセスでは、有効な JSON または XML 文字列を 給与責任者 が使用できるデータに変換する方法として、「変数または保存された値の更新」タイプのアクションを使用します。 JSON、XML、または XML コレクションのデータ型を宣言し、選択したデータ型の有効な文字列データを保持する変数を作成します。
Webhook認証
このリリースでは、Webhooks 機能は API キー認証のみをサポートしますが、将来のリリースでは拡張される予定です。
通常、Webhook エンドポイントに設定する認証の種類は、イベントが開始されるサードパーティ ツールによって異なります。 たとえば、Amazon Simple Notification Services (SNS) は、Webhook に基本認証を使用します。 Jira Software などの他のツールでは認証は使用されません。
