メインコンテンツへスキップ

​
はじめに

トリガーは Workflow アプリケーションでのみ利用可能です。
プラグイントリガーは、外部システムで特定のイベントが発生したときに自動的にワークフローを開始します。必要なのは、トリガープラグインを通じてこれらのイベントをサブスクライブし、対応するプラグイントリガーをワークフローに追加することだけです。 例えば、GitHub トリガープラグインをインストールしたとします。これは、Pull Request、Push、Issue を含む、サブスクライブできる GitHub イベントのリストを提供します。Pull Request イベントをサブスクライブし、Pull Request プラグイントリガーをワークフローに追加すると、指定されたリポジトリで誰かがプルリクエストを開くたびに自動的に実行されます。

​
プラグイントリガーの追加と設定

  1. ワークフローキャンバスで右クリックし、ブロックを追加 > 始める を選択してから、利用可能なプラグイントリガーの中から選択するか、Dify Marketplace でさらに検索します。
    • 対象の外部システムに適切なトリガープラグインがない場合は、コミュニティにリクエストしたり、自分で開発したり、代わりに Webhook トリガーを使用したりできます。
    • 1 つのワークフローに複数のプラグイントリガーを含めることができます。これらのトリガーブランチが同じ下流ノードを共有する場合、変数集約器 を追加してそれらを集約し、各ブランチでノードを重複させないようにします。
  2. 既存のサブスクリプションを選択するか、新しいサブスクリプションを作成します。
    プラグイン 配下のプラグイン詳細パネルから、特定のサブスクリプションを使用しているワークフローの数を確認できます。
  3. その他の必要な設定を行います。
プラグイントリガーの出力変数は、そのトリガープラグインによって定義されており、変更できません。

​
新しいサブスクリプションを作成

トリガープラグインは、ワークスペースごとに最大 10 個のサブスクリプションをサポートします。
各サブスクリプションは Webhook 上に構築されています。サブスクリプションを作成する際、実際には外部システムからのイベントをリッスンする Webhook を設定しています。
Webhook を使用すると、あるシステムが別のシステムにリアルタイムでデータを自動的に送信できます。特定のイベントが発生すると、ソースシステムはイベントの詳細を HTTP リクエストにパッケージ化し、宛先システムが提供する指定された URL に送信します。
前提条件：コールバック URL のベースプレフィックスを設定するDify は、TRIGGER_URL 環境変数とプラグイン固有のパスを組み合わせて、各サブスクリプションのコールバック URL を生成します。デフォルトは http://localhost で、外部システムからは到達できません。サブスクリプションを作成する前に、デプロイ環境の TRIGGER_URL を外部システムから到達可能な公開ドメインまたは IP アドレスに設定し、Dify を再起動してください。
Dify は以下の 2 つの方法でサブスクリプション（Webhook）を作成することをサポートしていますが、各プラグインで利用可能なオプションは、そのプラグインの設計方法によって異なります。
  • 自動作成：サブスクライブしたいイベントを選択すると、Dify が外部システムで対応する Webhook を自動的に作成します。これには、Dify が Webhook のセットアップを代行できるように、 OAuth または API キー による事前の認証が必要です。
  • 手動作成：Dify が提供する Webhook コールバック URL を使用して、自分で Webhook を作成します。認証は不要です。
サブスクリプションの作成方法
サブスクリプションを作成する際は、利用可能なすべてのイベントを選択することをお勧めします。プラグイントリガーは、対応するイベントがリンクされたサブスクリプションに含まれている場合にのみ機能します。利用可能なすべてのイベントを選択すると、後でワークフローに追加するプラグイントリガーが同じサブスクリプションを使用でき、サブスクリプションを更新したり新しく作成したりする必要がなくなります。
  1. OAuth 経由 > カスタムを選択します。
  2. 外部システムで、Dify が提供するコールバック URL を使用して新しい OAuth アプリケーションを作成します。
  3. Dify に戻り、新しく作成した OAuth アプリケーションのクライアント ID とクライアントシークレットを入力してから、保存と承認 をクリックします。
    保存後、同じクライアント認証情報を今後のサブスクリプションで再利用できます。
  4. サブスクリプション名を指定し、サブスクライブするイベントを選択し、その他の必要な設定を行います。
    利用可能なすべてのイベントを選択することをお勧めしますが、後から プラグイン 配下のプラグイン詳細パネルでいつでも選択を変更できます。
  5. 作成 をクリックします。
表示されている コールバック URL は、Dify が外部システムで Webhook を作成する際に内部的に使用されます。このため、ユーザー側でこの URL に対して操作を行う必要はありません。

​
プラグイントリガーをテストする

未公開のプラグイントリガーをテストするには、まず このステップ実行 をクリックするか、ワークフロー全体をテスト実行する必要があります。これによりトリガーがリスニング状態になり、外部イベントを監視できるようになります。そうしないと、イベントが発生してもトリガーはサブスクライブしたイベントをキャプチャしません。