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

はじめに

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

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

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

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

サブスクリプションは一度作成すると変更できません。変更するには、既存のサブスクリプションを削除して新しいサブスクリプションを作成してください。
トリガープラグインは、ワークスペースごとに最大 10 個のサブスクリプションをサポートします。
各サブスクリプションは Webhook 上に構築されています。サブスクリプションを作成する際、実際には外部システムからのイベントをリッスンする Webhook を設定しています。
Webhook を使用すると、あるシステムが別のシステムにリアルタイムでデータを自動的に送信できます。特定のイベントが発生すると、ソースシステムはイベントの詳細を HTTP リクエストにパッケージ化し、宛先システムが提供する指定された URL に送信します。
Dify は以下の 2 つの方法でサブスクリプション(Webhook)を作成することをサポートしていますが、各プラグインで利用可能なオプションは、そのプラグインの設計方法によって異なります。
  • 自動作成:サブスクライブしたいイベントを選択すると、Dify が外部システムで対応する Webhook を自動的に作成します。これには、Dify が Webhook のセットアップを代行できるように、 OAuth または API キーによる事前の認証が必要です。
  • 手動作成:Dify が提供する Webhook コールバック URL を使用して、自分で Webhook を作成します。認証は不要です。
Ways to Create Subscriptions
サブスクリプションを作成する際は、利用可能なすべてのイベントを選択することをお勧めします。プラグイントリガーは、対応するイベントがリンクされたサブスクリプションに含まれている場合にのみ機能します。利用可能なすべてのイベントを選択すると、後で workflow に追加するプラグイントリガーが同じサブスクリプションを使用でき、別のサブスクリプションを作成する必要がなくなります。
  • OAuth 経由(自動)
  • API キーで作成(自動)
  • URL を貼り付けて新しいサブスクリプションを作成(手動)
Dify Cloud では、多くの人気のあるトリガープラグインにデフォルトの OAuth クライアントが事前設定されているため、ワンクリックで Dify を認証できます。セルフホスト環境では、カスタム OAuth クライアントオプションのみが利用可能です。つまり、外部システムで OAuth アプリケーションを自分で作成する必要があります。
  • デフォルト OAuth クライアント
  • カスタム OAuth クライアント
  1. OAuth 経由 > デフォルト > 保存と承認を選択します。
    保存は、選択したオプションが今後のサブスクリプションのデフォルトの OAuth 方法として設定されることを意味します。後で方法を切り替えるには、OAuth クライアント設定アイコンをクリックします。OAuth Client Settings Icon
  2. ポップアップ表示される外部システムの認証ページで、次へをクリックして Dify にアクセスを許可します。
  3. サブスクリプション名を指定し、サブスクライブするイベントを選択し、その他の必要な設定を行います。
    利用可能なすべてのイベントを選択することをお勧めします。
  4. 作成をクリックします。
表示されているコールバック URLは、Difyが外部システムでWebhookを作成する際に内部的に使用されるため、ユーザー側でこのURLに対して何か操作を行う必要はありません。セルフホスティング環境では、TRIGGER_URL環境変数でURLのベースプレフィックスを変更できます。プレフィックスは外部システムからアクセス可能な公開ドメインまたはIPアドレスを指定してください。

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

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