ドキュメントの検索
karat

+

K

APIリファレンス ↗
オントロジーアクションタイプサイドエフェクトWebhook の設定
Feedback

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

Webhook の設定

前提条件

  1. 基本的な Action の設定方法を学ぶために、getting started チュートリアルを完了してください。
  2. 外部システムとの接続を作成するために、Webhook を設定します。Webhook を作成する前に、ソースシステムに接続する権限を持つシステム管理者と協力する必要があるかもしれません。

手順

以下の例では、priority 文字列値を受け入れて外部システムに送信する Modify ticket priority という Webhook を持っていると仮定します。

Action に移動し、Logic タブを選択し、Add new rule を選択し、次に Webhook を選択します。

Add new Webhook

デフォルトでは、新しく追加された Webhook は side effect として設定されています。これにより、Webhook は Foundry 内のオブジェクトが編集された に実行されます。代わりに Writeback を選択すると、Webhook はオブジェクトの編集 に実行されます。

Select writeback or side effect

以下のメニューで、実行したい Webhook を選択します。この例では、Modify ticket priority Webhook を選択します。必要に応じて、Webhook の別のバージョンを選択することもできます。

Select Webhook to execute

次に、Webhook の入力パラメーターを Action パラメーターに基づいて設定します。デフォルトでは、Webhook 入力ごとに新しい Action パラメーターが生成されます。ただし、同じ名前の既存の Action パラメーターが存在する場合は、既存のパラメーターが自動的に設定されます。この例では、priority と呼ばれる Webhook 入力を Ticket Priority と呼ばれる既存の Action パラメーターにマッピングします。

Mapping Webhook input to an existing Action parameter

Add webhook を選択して、Webhook ルールの追加を完了します。Webhook が追加された後、Rules セクションでは、書き戻しがオブジェクトが変更される前に発生することが示されています。

Add new Webhook (completed)

Webhook を追加したときに作成された自動生成されたパラメーターが使用されていない場合、それらを削除することができます。

Remove autogenerated parameters

右上の Save を選択して、Action への変更を保存します。これで、Action が適用されたときに、Foundry のオブジェクトに変更が適用される前に外部システムへのリクエストが送信されます。

次のステップ

このチュートリアルでは、Action に Webhook を追加する方法を示しました。さらに学ぶために、これらのリソースを試してみてください:

  • Webhooks セクションを参照して、Actions で利用可能な全ての Webhook のオプションについて学びます。
  • Functions を使用して Webhook 入力パラメーターを設定する方法を学びます。
  • Data Connection での Webhooks concept について詳しく学びます。