ウェブフック (Orchestrator)

本コンテンツはPhrase Language AIの機械翻訳により、英語から翻訳されています。

ウェブフックは、チャットクライアントやその他の外部APIなどの外部サービスにイベントを通知します。ウェブフックは、特定のイベントが発生したときにURLを設定できます。

Phrase Orchestratorは、サードパーティシステムからの通知を監視および処理するサービスを提供します。このサービスにより、ユーザーはHTTPリクエストをサポートする多種多様な外部システムとワークフローを接続できます。

着信ウェブフック

ユーザーは、外部イベントからの着信ウェブフック用の新しいトリガーを作成でき、システムがサードパーティのウェブフックセットアップ用のAPIキーを含む一意のウェブフックURLを自動的に生成します。生成されたウェブフックURLは一意であり、ユーザーのアカウントおよびワークフローと直接関連付けられているため、各ウェブフックは1つのワークフローにのみ紐付けられます。

着信ウェブフックを構成する

ウェブフックをセットアップするには、以下の手順に従ってください：

Webhook トリガーをワークフローにドラッグアンドドロップします。

トリガーがワークフローに表示されます。
トリガーをクリックしてOverviewタブを開きます。
Webhook タブを選択。
1. Webhook URLをコピーします。
  
  このURLは機密情報と見なし、共有しないでください。誤って共有した場合は、Regenerateをクリックして新規作成し、既存の共有を無効にします。
2. ワークフロー内で使用するデータを含むペイロードを送信するには、そのペイロードのスキーマを提供してください。
  1. スキーマを入力するには、Edit webhookをクリックします。
  2. Input Typeの選択：
    
    JSONスキーマは、JSONペイロードを定義するための標準です。それらを使用する既存のサービス、またはOrchestratorに接続するための外部サービスがスキーマを提供している場合は、それをそのままコピーしてください。
    - JSON
      
      よりシンプルなセットアップのためにサンプルJSONペイロードを提供し、正確なルールを定義せずにウェブフックのテストを行えるようにします。
    - JSON Schema
      
      JSONデータの構造、データ型、および検証ルールを正確に定義します。
  3. Save payload schemaをクリックします。
    
    ウェブフックトリガーの期待されるデータ構造のプレビューが表示されます。
3. 必要に応じて、Filtersタブを開いてトリガーにフィルタを追加します。

ワークフローを公開した後にトリガーするには、ウェブフックURLにPOSTリクエストを送信します。スキーマが設定されていないワークフローの場合、本文は空欄である必要があります。設定されたスキーマが適用される場合、ペイロードはスキーマと一致する必要があります。

送信ウェブフック

ユーザーは、データを受信するだけでなく、外部システムへ自動的に更新を送信するワークフローを設定できます。送信ウェブフックアクションを使用すると、ユーザーは外部システムで特定のアクションを自動的にトリガーできます。

他のサービスのウェブフックは、HTTPリクエストを送信アクションを通じてトリガーできます。

送信ウェブフックを設定する

送信ウェブフックを設定するには、次の手順に従ってください。

「Send HTTP Request」アクションをワークフローにドラッグアンドドロップします。
アクションをクリックして設定を開きます。
Parametersタブを選択し、必要な設定を行います。
Save parametersをクリックします。