---
title: "Test a workflow"
method: POST
path: "/workflows/{workflowId}/test"
tags: ["Workflows"]
---

# Test a workflow

`POST /workflows/{workflowId}/test`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/workflows/{workflowId}/test`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `flow`, `flow:workflows`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/workflows/:workflowId/test/post.ts> (a function with typed inputs; its response is checked against the schema)

Validate a workflow in our Sandbox environment.

## Path parameters

- `workflowId` string, required

## Request body

- TestWorkflowRequest
  - `event_types` object: Map of source names to their corresponding event types (e.g., gateway, issuing, authentication, etc.)

## Response `204`

Workflow test initiated

## Other responses

- `401`: Unauthorized
- `404`: Workflow not found
- `422`: Invalid data was sent
- `500`: Internal Error

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)