ワークフローを設定する公開プレビュー

1. ダッシュボードのワークフローに移動します。

2. 新しいワークフロー をクリックして、ワークフローエディターを開きます。

3. 名称未設定のワークフロー をクリックし、ワークフローの名前を入力します。

4. トリガーを追加 をクリックします。

   • 各ワークフローには、トリガーを 1 つだけ設定できます。
   • トリガーは、ワークフローの開始に使用できる Stripe API の公開イベントです。
   • 検索するか、提案されたトリガーの 1 つから選択できます。カテゴリー別に参照して、オプションを絞り込むこともできます。

5. トリガーを選択した後、条件を追加することで、ワークフローを実行するタイミングをさらに指定できます。

   • リスト条件では、最大 100 の項目が評価されます。たとえば、項目のリストを含むフィールドに条件を設定する場合、ワークフローは最初の 100 の項目のみを評価して、条件が満たされているかどうかを判断します。制限を超える項目は評価されません。
   • ワークフローは、トリガー条件が true の場合にのみ実行されます。

6. ステップを追加 をクリックします。アクションまたは条件のいずれかを選択できます。

   • Each workflow can support up to 12 steps.
   • Dynamic values are pulled from a specific step, which might become outdated if the object changes after that step is run or an event is triggered. However, each action is run using the object’s current, most up-to-date version.

7. 次に、パラメーターに値を追加してアクションを構成します。ワークフローを実行するには、すべての必須フィールドに入力する必要があります。これらのプロパティは 必須 とマークされています。

8. 必要に応じてステップを追加します。

9. 有効化 をクリックします。

作成できるワークフローの例については、ユースケースを参照してください。

After you save and activate your workflow, test your workflow. You need to test the trigger, trigger conditions (if applicable), and the sequential steps you applied.

For example, to test a workflow that triggers whenever a new customer is created:

1. サンドボックスを作成して、本番環境のアカウントに影響を与えることなくワークフローを安全にテストします。
2. ダッシュボードの顧客に移動します。
3. + 新規顧客 をクリックします。
4. 顧客の詳細を入力し、名前が顧客のファーストネーム (「John」など) で始まることを確認します。
5. 顧客を追加 をクリックします。

After triggering the workflow, check its run details:

1. ダッシュボードのワークフローに移動します。

2. 該当するワークフローをクリックします。

3. 最近の実行 で、作成してトリガーしたテスト ワークフローを表す最新の実行エントリーを表示します。

   • ワークフローが正常に実行されると、ステータスに 成功 バッジが表示されます。
   • ワークフローが失敗した場合、ステータスに 失敗 バッジが表示されます。

4. Click the run to see the details of each step run by the workflow. If you click a step, you can also click Inspect in Workbench to see developer-focused Workbench logs generated from the actions taken in the workflow.

   • Workbench is available for trigger events, allowing you to navigate directly to the event tab in Workbench, and for actions where you can access the applicable request log.
   • This isn’t available for Workflows-specific steps such as sending emails or evaluating conditions including branching.

5. In the Run history view, click the overflow menu () > Inspect resource to explore a JSON view of the object that triggered the workflow using Workbench.

失敗したワークフロー

ワークフローが失敗した場合:

1. In the Run history view, click the steps that failed to see the error message.

2. エラーメッセージを使用して手順を修正します。また、Workbench で検査 をクリックして、ワークフローによって生成された開発者向けの Workbench ログを表示することもできます。

3. Click Retry run to directly re-trigger the workflow using the same trigger data.

   • You can only retry runs on workflows that are active.
   • You can rerun a workflow using its original event data for up to 30 days after the initial trigger was met.

4. Verify if the rerun successfully completes (if the rerun starts from the initial trigger and proceeds through all steps in the workflow).

ワークフローを使用した Workbench ビュー

ワークフローをアクティブ化、非アクティブ化、または削除できます。ワークフローを非アクティブにすると、Stripe はワークフローを無効と見なし、トリガーに応答しなくなります。

一度に最大 6 つのアクティブなワークフローを維持でき、アクティブなワークフローと非アクティブなワークフローの両方を含む合計 20 のワークフローを持つことができます。ワークフローが 20 個ある場合、別のワークフローを作成することはできません。アクティブなワークフローが 6 つあり、別のワークフローをアクティブにする場合は、まず既にアクティブなワークフローを非アクティブにする必要があります。

ワークフローを非アクティブにするには:

1. ワークフローに移動し、該当するワークフローを選択します。
2. 非アクティブ化 をクリックします。ワークフローを再びアクティブにする場合は、アクティブ化 をクリックします。

ワークフローを削除する

ワークフローの削除は恒久的です。削除後、ワークフローは元に戻せません。ワークフローを削除する前に再確認してください。不明な場合は、削除するのではなく、非アクティブにすることを検討してください。

ワークフローを削除するには:

1. ワークフローに移動し、該当するワークフローを選択します。
2. 非アクティブ化 の横にあるオーバーフローメニュー () > ワークフローの削除 をクリックします。
3. モーダルで 削除 をクリックします。

これで、ワークフローが実行の詳細とともに完全に削除されました。