> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/workato.md).

# Workato

Connect to Workato to list recipes and see which are running, start and stop recipes, and review job history to find failures, from your AI workflows.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector           | Authentication |
| ------------------- | -------------- |
| Workato (API Token) | API Token      |

### Workato (API Token)

Connect to Workato with an API client token to list recipes, start and stop them, and review job history. What this connection can reach is governed by the API client's role, environment assignment, and project scope, all configured in Workspace admin > API clients.

#### Set up in Workato

1. Prepare the Workato account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Token:** A Workato API client token, minted under Workspace admin > API clients > Create API client. The token is view-once: copy it immediately, since it cannot be viewed again after you leave the page. The client's role decides which endpoints work: for example, a role such as Recipe Operator is needed to start or stop recipes, separately from a role that can only list them.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Workato (API Token)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                                                                   |
| ------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Token     | Yes                      | A Workato API client token, minted under Workspace admin > API clients > Create API client. The token is view-once: copy it immediately, since it cannot be viewed again after you leave the page. The client's role decides which endpoints work: for example, a role such as Recipe Operator is needed to start or stop recipes, separately from a role that can only list them.                              |
| Region        | Optional / as applicable | The Workato data center this workspace is hosted in: 'us' (US), 'eu' (EU), 'jp' (Japan), 'sg' (Singapore), 'au' (Australia), 'il' (Israel), 'cn' (China), 'kr' (South Korea), 'uk' (UK), or 'trial' (Self-service/trial). This is the API host, which is not always the same as the app URL you log in at: the US API host is [www.workato.com](http://www.workato.com) while the US app UI is app.workato.com. |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Workato** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Recipes

List recipes in your Workato workspace and see which are running or stopped.

#### Inputs

| Field              | Type            | Required | Description                                                                                                                                                        |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status             | select (string) | No       | Show all recipes, or only the ones currently running, or only the stopped ones. Available values: Any, Running, Stopped. Default: any.                             |
| Folder             | select (string) | No       | Only show recipes inside one Workato folder or project. Options load from the selected connection.                                                                 |
| Include subfolders | boolean         | No       | Also include recipes in folders nested inside the folder you picked.                                                                                               |
| Stopped because    | select (string) | No       | Only show recipes that Workato stopped for one specific reason. Available values: trigger\_errors\_limit, action\_quota\_limit, trial\_expired, txn\_quota\_limit. |
| Updated after      | datetime        | No       | Only show recipes that changed after this moment.                                                                                                                  |
| Max results        | integer         | No       | Most recipes to return. Minimum: 1. Maximum: 100. Default: 25.                                                                                                     |
| Page               | integer         | No       | Continue an earlier listing from where it stopped. Minimum: 1.                                                                                                     |

#### Outputs

| Field          | Type          | Description                             |
| -------------- | ------------- | --------------------------------------- |
| Recipes        | object\_array | The recipes that matched.               |
| Returned count | integer       | How many recipes were returned.         |
| Next page      | integer       | Page number to ask for to keep listing. |

### Start Recipe

Turn a recipe on so it begins running.

#### Inputs

| Field  | Type            | Required | Description                                                     |
| ------ | --------------- | -------- | --------------------------------------------------------------- |
| Recipe | select (string) | Yes      | The recipe to start. Options load from the selected connection. |

#### Outputs

| Field           | Type    | Description                                                 |
| --------------- | ------- | ----------------------------------------------------------- |
| Recipe ID       | integer | The recipe that was started.                                |
| Recipe name     | string  | Name of the recipe.                                         |
| Running         | boolean | Whether the recipe is running now.                          |
| Already running | boolean | True if the recipe was already running and nothing changed. |

### Stop Recipe

Turn a running recipe off so it stops firing.

#### Inputs

| Field  | Type            | Required | Description                                                    |
| ------ | --------------- | -------- | -------------------------------------------------------------- |
| Recipe | select (string) | Yes      | The recipe to stop. Options load from the selected connection. |

#### Outputs

| Field           | Type    | Description                                                 |
| --------------- | ------- | ----------------------------------------------------------- |
| Recipe ID       | integer | The recipe that was stopped.                                |
| Recipe name     | string  | Name of the recipe.                                         |
| Running         | boolean | Whether the recipe is running now.                          |
| Already stopped | boolean | True if the recipe was already stopped and nothing changed. |

### List Recipe Jobs

List jobs (runs) for one recipe and see which succeeded or failed.

#### Inputs

| Field       | Type            | Required | Description                                                                                                                            |
| ----------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Recipe      | select (string) | Yes      | The recipe whose runs you want to see. Options load from the selected connection.                                                      |
| Status      | select (string) | No       | Show all runs, or only the successful, failed, or still-pending ones. Available values: Any, Succeeded, Failed, Pending. Default: any. |
| Max results | integer         | No       | Most runs to return. Minimum: 1. Maximum: 500. Default: 25.                                                                            |
| Reruns only | boolean         | No       | Only show runs that were retries of an earlier run.                                                                                    |
| Cursor      | string          | No       | Continue an earlier listing from where it stopped.                                                                                     |

#### Outputs

| Field                    | Type          | Description                                            |
| ------------------------ | ------------- | ------------------------------------------------------ |
| Jobs                     | object\_array | The runs that matched.                                 |
| Returned count           | integer       | How many runs were returned.                           |
| Succeeded (recipe total) | integer       | Total successful runs Workato reports for this recipe. |
| Failed (recipe total)    | integer       | Total failed runs Workato reports for this recipe.     |
| Next cursor              | string        | Cursor to pass back to keep listing.                   |

### Get Job Details

See what happened in one recipe run, including why it failed.

#### Inputs

| Field  | Type            | Required | Description                                                               |
| ------ | --------------- | -------- | ------------------------------------------------------------------------- |
| Recipe | select (string) | Yes      | The recipe the run belongs to. Options load from the selected connection. |
| Job    | select (string) | Yes      | The run to open. Options load from the selected connection.               |

#### Outputs

| Field                | Type          | Description                                                |
| -------------------- | ------------- | ---------------------------------------------------------- |
| Job ID               | string        | The run that was read.                                     |
| Recipe ID            | integer       | The recipe this run belongs to.                            |
| Title                | string        | Workato's short label for the run.                         |
| Status               | string        | Outcome of the run.                                        |
| Failed               | boolean       | Whether the run failed.                                    |
| Trigger poll failure | boolean       | True when the failure was the trigger polling, not a step. |
| Started at           | datetime      | When the run began.                                        |
| Completed at         | datetime      | When the run finished.                                     |
| Error message        | string        | Why the run failed, if it did.                             |
| Error type           | string        | Workato's classification of the failure.                   |
| Underlying error     | string        | The message the connected app returned, if any.            |
| Failed at            | datetime      | When the failure happened.                                 |
| Steps                | object\_array | What each step of the run did.                             |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/workato.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
