Webhooks (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をクリックします。