プラグイントリガー¶

Note: ⚠️ このドキュメントはAIによって自動翻訳されています。不正確な部分がある場合は、英語版を参照してください。

はじめに¶

Info:

トリガーはワークフローアプリケーションでのみ利用可能です。

プラグイントリガーは、外部システムで特定のイベントが発生したときに自動的にワークフローを開始します。必要なのは、トリガープラグインを通じてこれらのイベントをサブスクライブし、対応するプラグイントリガーをワークフローに追加することだけです。

例えば、GitHub トリガープラグインをインストールしたとします。これは、Pull Request、Push、Issue を含む、サブスクライブできる GitHub イベントのリストを提供します。Pull Request イベントをサブスクライブし、Pull Request プラグイントリガーをワークフローに追加すると、指定されたリポジトリで誰かがプルリクエストを開くたびに自動的に実行されます。

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

ワークフローキャンバスで右クリックし、ブロックを追加 > 始める を選択してから、利用可能なプラグイントリガーの中から選択するか、FlexAI Marketplace でさらに検索します。

Tip:

    - 対象の外部システムに適切なトリガープラグインがない場合は、[コミュニティにリクエスト](https://github.com/flexai/flexai-plugins/issues/new?template=plugin_request.yaml)したり、[自分で開発](/ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin)したり、代わりに [Webhook トリガー](/ja/use-flexai/nodes/trigger/webhook-trigger)を使用したりできます。

    - 1 つのワークフローは、並行して実行される複数のプラグイントリガーで開始できます。並行分岐に同一の連続したノードが含まれている場合、共通セクションの前に[変数集約](/ja/use-flexai/nodes/variable-aggregator)ノードを追加して分岐をマージできます。これにより、各分岐で同じノードを個別に重複して追加することを回避できます。

既存のサブスクリプションを選択するか、新しいサブスクリプションを作成します。

Tip:

    **プラグイン**配下のプラグイン詳細パネルから、特定のサブスクリプションを使用しているワークフローの数を確認できます。

その他の必要な設定を行います。

Info:

プラグイントリガーの出力変数は、そのトリガープラグインによって定義されており、変更できません。

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

Info:

トリガープラグインは、ワークスペースごとに最大 10 個のサブスクリプションをサポートします。

各サブスクリプションは Webhook 上に構築されています。サブスクリプションを作成する際、実際には外部システムからのイベントをリッスンする Webhook を設定しています。

Webhook とは？

Webhook を使用すると、あるシステムが別のシステムにリアルタイムでデータを自動的に送信できます。特定のイベントが発生すると、ソースシステムはイベントの詳細を HTTP リクエストにパッケージ化し、宛先システムが提供する指定された URL に送信します。

FlexAI は以下の 2 つの方法でサブスクリプション（Webhook）を作成することをサポートしていますが、各プラグインで利用可能なオプションは、そのプラグインの設計方法によって異なります。

自動作成：サブスクライブしたいイベントを選択すると、FlexAI が外部システムで対応する Webhook を自動的に作成します。これには、FlexAI が Webhook のセットアップを代行できるように、 OAuth または API キーによる事前の認証が必要です。
手動作成：FlexAI が提供する Webhook コールバック URL を使用して、自分で Webhook を作成します。認証は不要です。

Ways to Create Subscriptions

Tip:

サブスクリプションを作成する際は、利用可能なすべてのイベントを選択することをお勧めします。

プラグイントリガーは、対応するイベントがリンクされたサブスクリプションに含まれている場合にのみ機能します。利用可能なすべてのイベントを選択すると、後でワークフローに追加するプラグイントリガーが同じサブスクリプションを使用でき、サブスクリプションを更新したり新しく作成したりする必要がなくなります。

OAuth 経由（自動）:

FlexAI Cloud では、多くの人気のあるトリガープラグインにデフォルトの OAuth クライアントが事前設定されているため、ワンクリックで FlexAI を認証できます。

セルフホスト環境では、カスタム OAuth クライアントオプションのみが利用可能です。つまり、外部システムで OAuth アプリケーションを自分で作成する必要があります。

デフォルト OAuth クライアント:

            1. **OAuth 経由** > **デフォルト** > **保存と承認**を選択します。

Info:

                    **保存**は、選択したオプションが今後のサブスクリプションのデフォルトの OAuth 方法として設定されることを意味します。

                    後で方法を切り替えるには、**OAuth クライアント設定**アイコンをクリックします。

                    <img src="/images/oauth_client_settings_icon.png" alt="OAuth Client Settings Icon" width="300" />




            2. ポップアップ表示される外部システムの認証ページで、**次へ**をクリックして FlexAI にアクセスを許可します。

            3. サブスクリプション名を指定し、サブスクライブするイベントを選択し、その他の必要な設定を行います。

Tip:

                    利用可能なすべてのイベントを選択することをお勧めしますが、後から**プラグイン**配下のプラグイン詳細パネルでいつでも選択を変更できます。

            4. **作成**をクリックします。

カスタム OAuth クライアント:

        1. **OAuth 経由** > **カスタム**を選択します。

        2. 外部システムで、FlexAI が提供するコールバック URL を使用して新しい OAuth アプリケーションを作成します。

        3. FlexAI に戻り、新しく作成した OAuth アプリケーションのクライアント ID とクライアントシークレットを入力してから、**保存と承認**をクリックします。

Info:

                保存後、同じクライアント認証情報を今後のサブスクリプションで再利用できます。

        4. サブスクリプション名を指定し、サブスクライブするイベントを選択し、その他の必要な設定を行います。

Tip:

                利用可能なすべてのイベントを選択することをお勧めしますが、後から**プラグイン**配下のプラグイン詳細パネルでいつでも選択を変更できます。

        5. **作成**をクリックします。

Info:

        表示されている**コールバック URL**は、FlexAIが外部システムでWebhookを作成する際に内部的に使用されるため、ユーザー側でこのURLに対して何か操作を行う必要はありません。

        セルフホスティング環境では、`TRIGGER_URL`環境変数でURLのベースプレフィックスを変更できます。プレフィックスは外部システムからアクセス可能な公開ドメインまたはIPアドレスを指定してください。

API キーで作成（自動）:

1. **API キーで作成**を選択します。

2. 必要な認証情報を入力してから、**検証**をクリックします。

3. サブスクリプション名を指定し、サブスクライブするイベントを選択し、その他の必要な設定を行います。

Tip:

        利用可能なすべてのイベントを選択することをお勧めしますが、後から**プラグイン**配下のプラグイン詳細パネルでいつでも選択を変更できます。

4. **作成**をクリックします。

Info:

    表示されている**コールバック URL**は、FlexAIが外部システムでWebhookを作成する際に内部的に使用されるため、ユーザー側でこのURLに対して何か操作を行う必要はありません。

    セルフホスティング環境では、`TRIGGER_URL`環境変数でURLのベースプレフィックスを変更できます。プレフィックスは外部システムからアクセス可能な公開ドメインまたはIPアドレスを指定してください。

URL を貼り付けて新しいサブスクリプションを作成（手動）:

1. **URL を貼り付けて新しいサブスクリプションを作成**を選択します。

2. サブスクリプション名を指定し、提供されたコールバック URL を使用して外部システムで手動で Webhook を作成します。

Info:

        セルフホスティング環境では、`TRIGGER_URL`環境変数でコールバックURLのベースプレフィックスを変更できます。

        プレフィックスは外部システムからアクセス可能な公開ドメインまたはIPアドレスを指定してください。



3. （オプション）作成した Webhook をテストします。

Info:

        ほとんどの外部システムは、作成時に FlexAI に ping リクエストを送信することで、新しい Webhook を自動的にテストします。

    1. サブスクライブしたイベントをトリガーして、外部システムがコールバック URL に HTTP リクエストを送信するようにします。

    2. **手動設定**ページに戻り、ページ下部の**リクエストログ**セクションを確認します。Webhook が正しく機能している場合、受信したリクエストと FlexAI のレスポンスが表示されます。

        <img src="/images/plugin_trigger_manual_setup_request_logs.png" alt="Request Logs" width="563" />

4. **作成**をクリックします。

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

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