# ワークフローを設定する

ダッシュボードでワークフローを設定する方法は以下のとおりです。

タスクを自動化するワークフローを作成できます。Stripe イベントでワークフローをトリガーすることも、プログラムで呼び出すこともできます。

## Before you begin

- 一度に実行できる有効なワークフローは最大 50 です。
- [サンドボックス](https://docs.stripe.com/sandboxes.md)を作成して、ワークフローの作成と実行をテストします。新機能を試したり、トラブルシューティングを行ったり、本番運用に影響を与えずに問題を修正したりできます。
- [Workflows の仕組み](https://docs.stripe.com/workflows/define-workflows.md)を理解してください。

## ワークフローを作成する

1. ダッシュボードで [Workflows](https://dashboard.stripe.com/workflows) に移動します。
2. **新しいワークフロー**をクリックすると、ワークフロービルダーが開きます。
3. **名称未設定のワークフロー** をクリックし、ワークフローの名前を入力します。
4. **トリガーを追加** をクリックします。
   - 各ワークフローには、トリガーを 1 つだけ設定できます。
   - [トリガー](https://docs.stripe.com/workflows/define-workflows.md#triggers)とは、ワークフローの開始に使用できる任意の公開 Stripe API イベントです。[プログラムによるトリガー](https://docs.stripe.com/workflows/programmatic-triggers.md)を選択して、手動または API でワークフローを開始することもできます。
   - 推奨されるトリガーを 1 つ選択します。カテゴリで検索または参照できます。
5. トリガーを選択したら、[条件](https://docs.stripe.com/workflows/define-workflows.md#trigger-conditions)を追加してワークフローを実行するタイミングを指定します。
   - リスト条件では、最大 100 の項目が評価されます。たとえば、項目のリストを含むフィールドに条件を設定する場合、ワークフローは最初の 100 の項目のみを評価して、条件が満たされているかどうかを判断します。制限を超える項目は評価されません。
   - ワークフローは、トリガー条件が true の場合にのみ実行されます。
6. **ステップを追加**をクリックします。[アクション](https://docs.stripe.com/workflows/define-workflows.md#actions)、[条件](https://docs.stripe.com/workflows/define-workflows.md#conditions)、または[ループ](https://docs.stripe.com/workflows/loops.md)を選択できます。
   - 動的な値は特定のステップで取得されますが、そのステップの実行後またはイベントのトリガー後にオブジェクトが変更されると、値が古くなる可能性があります。ただし、各アクションは、オブジェクトの最新バージョンによって実行されます。
7. 次に、パラメーターに値を追加してアクションを設定します。ワークフローを実行するには、すべての必須フィールドに入力する必要があります。これらのプロパティは **必須** としてマークされます。
8. 必要に応じてステップを追加します。
9. **公開**をクリックします。

### イベントソースを選択する (Connect プラットフォーム)

Connect プラットフォームの場合、トリガーの設定時に **Monitor trigger on** という追加オプションが表示されます。これにより、どのアカウントのイベントでワークフローがトリガーされるかを制御できます。

- **お客様のアカウント**: ワークフローは、プラットフォームアカウントからのイベントでトリガーされます (デフォルト)。
- **連結アカウント**: ワークフローは、任意の連結アカウントからのイベントでトリガーされます。

ユースケースに合ったイベントソースを選択します。両方を選択することはできません。ワークフローは 1 つのイベントソースを監視します。

連結アカウントまたはプラットフォームアカウントに対して実行する個別のアクションを設定することもできます。詳細については、[連結アカウントでのアクション](https://docs.stripe.com/workflows/define-workflows.md#actions-on-connected-accounts)をご覧ください。

作成できるワークフローの例については、[ユースケース](https://docs.stripe.com/workflows/use-cases.md)をご覧ください。

## ワークフローをテストする

ワークフローを保存してアクティブにしたら、ワークフローをテストします。トリガー、トリガー条件 (該当する場合)、および適用した一連のステップをテストする必要があります。

たとえば、顧客を新規作成するたびにトリガーされるワークフローをテストするには、次のようにします。

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

### 連結アカウントでテストする

連結アカウントイベントでトリガーされるワークフローをテストするには、次の手順に従います。

1. 1 つ以上の連結アカウントを持つサンドボックス環境を使用します。
2. 連結アカウントでトリガーに一致するイベントを作成またはシミュレーションします。たとえば、ワークフローが `payment_intent.succeeded` でトリガーされる場合は、連結アカウントでテスト決済を作成します。
3. **実行履歴**にワークフローの実行が表示されることを確認します。実行の詳細には、実行をトリガーした連結アカウントが示されます。

サンドボックスに連結アカウントがない場合は、まずテスト用の連結アカウントを作成します。詳細は、[Connect の組み込みをテストする](https://docs.stripe.com/connect/testing.md)をご覧ください。

> アカウントに必要な権限がない場合、連結アカウントに対して実行されるアクションは失敗する可能性があります。権限エラーを診断するには、実行の詳細を確認してください。

## ワークフローを観察する

ワークフローをトリガーした後、その実行の詳細を確認します。

1. ダッシュボードで [Workflows](https://dashboard.stripe.com/workflows) に移動します。

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

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

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

4. 実行をクリックすると、ワークフローによって実行された各ステップの詳細が表示されます。ステップをクリックすると、**Workbench で検査** をクリックして、ワークフローで行われたアクションから生成された開発者向けの [Workbench](https://docs.stripe.com/workbench.md) ログを表示することもできます。

   - Workbench は、Workbench のイベントタブに直接移動できるトリガーイベントと、該当するリクエストログにアクセスできるアクションで使用可能です。
   - メールの送信や分岐を含む条件の評価など、ワークフロー固有のステップでは使用できません。

5. **実行履歴**ビューで、オーバーフローメニュー (⋯) > **リソースを検査**をクリックして、[Workbench](https://docs.stripe.com/workbench/overview.md#inspector)を使用してワークフローをトリガーしたオブジェクトの JSON ビューを確認します。

### 失敗したワークフロー

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

1. **実行履歴** ビューで、エラー メッセージが表示されなかったステップをクリックします。
2. エラーメッセージを使用して手順を修正します。また、**Workbench で検査** をクリックして、ワークフローによって生成された開発者向けの [Workbench](https://docs.stripe.com/workbench.md) ログを表示することもできます。
3. 問題を修正したら、新しいワークフロー実行を作成して修正を確認します。
![ワークフローを使用した Workbench ビュー](https://b.stripecdn.com/docs-statics-srv/assets/workbench.d7d4401e2bd1fcd3e0884433acbf33a2.png)

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

## ワークフローを非アクティブ化

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

一度に維持できる有効なワークフローは最大 50 個で、有効 / 無効の合計も最大 50 個です。ワークフローが 50 個ある場合は、別のワークフローを作成できません。有効なワークフローが 50 個ある状態で新しいワークフローを有効化するには、まず既存の有効なワークフローを無効化する必要があります。

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

1. 1. [Workflows](https://dashboard.stripe.com/workflows) に移動して、該当するワークフローを選択します。
2. **非アクティブ化** をクリックします。ワークフローを再びアクティブにする場合は、**アクティブ化** をクリックします。

### ワークフローを削除する

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

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

1. [Workflows](https://dashboard.stripe.com/workflows) に移動して、該当するワークフローを選択します。
2. **非アクティブ化** の横にあるオーバーフローメニュー (⋯) > **ワークフローの削除** をクリックします。
3. モーダルで **削除** をクリックします。

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

## Optional: 過去のバージョンを表示

Workflow Editor で、以前にアクティブ化したワークフローのすべてのバージョンを直接表示できます。

1. エディターでワークフローを開きます。
2. ワークフロー名の横にあるバージョンドロップダウンをクリックします。
3. 過去のバージョンを選択すると、キャンバスで設定全体が表示されます。

これにより、ワークフローが履歴の任意の時点でどのように設定されていたかを確認できます。過去の実行に関する変更点やデバッグの問題を把握するのに役立ちます。

## See also

- [ワークフロー](https://docs.stripe.com/workflows/define-workflows.md)
- [ユースケース](https://docs.stripe.com/workflows/use-cases.md)
- [コレクションの反復処理](https://docs.stripe.com/workflows/loops.md)
- [カスタムアクションの作成](https://docs.stripe.com/workflows/custom-actions.md)
- [プログラムでワークフローをトリガーする](https://docs.stripe.com/workflows/programmatic-triggers.md)