Projects
WHO CAN USE THESE APIS?
Accounts with the environments feature enabled can use the APIs in this guide. Requests sent from accounts without this feature will receive a 400 - Environments not provisioned
response.
In Workato, projects are used to organize automation assets and control access. A project holds a set of related assets for your automations, including connections, recipes, and subfolders.
The Project APIs enable you to programmatically manage and deploy projects to the environments provisioned in your workspace.
Understanding project deployment
In Workato, there are two ways to deploy projects:
-
Build and then deploy. This approach can be used if you want to commit the package to an external version control system. Steps for accomplishing this would be similar to the following:
Build the project:
{{ $frontmatter.build_a_project.method }} {{ $frontmatter.build_a_project.endpoint }}
Verify the project built successfully:
{{ $frontmatter.get_project_build.method }} {{ $frontmatter.get_project_build.endpoint }}
If committing to a version control system like GitHub, use the
download_url
from Step 2’s response to download the package. -
Build and deploy in one step. If you don’t need to commit the project to a version control system, you can use this approach:
Quick reference
PRIVATE BETA
The following endpoints are in private beta:
- List eligible reviewers for a deployment
- Assign reviewers to a deployment
- Submit a deployment for review
- Approve a deployment
- Reject a deployment
- Re-open a deployment for review
- Update a deployment review comment
- Deploy an approved deployment
During the private beta, Workato may update its functionality or change its availability without prior notice.