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:

    1

    Build the project: {{ $frontmatter.build_a_project.method }} {{ $frontmatter.build_a_project.endpoint }}

    2

    Verify the project built successfully: {{ $frontmatter.get_project_build.method }} {{ $frontmatter.get_project_build.endpoint }}

    3

    If committing to a version control system like GitHub, use the download_url from Step 2’s response to download the package.

    4

    Commit the package to your version control system.

    5

    Deploy the project build to an environment: {{ $frontmatter.deploy_project_build.method }} {{ $frontmatter.deploy_project_build.endpoint }}

    6

    Verify the project deployed successfully: {{ $frontmatter.get_a_deployment.method }} {{ $frontmatter.get_a_deployment.endpoint }}

  • 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:

    1

    Build and deploy the project to an environment: {{ $frontmatter.deploy_a_project.method }} {{ $frontmatter.deploy_a_project.endpoint }}

    2

    Verify the project deployed successfully: {{ $frontmatter.get_a_deployment.method }} {{ $frontmatter.get_a_deployment.endpoint }}

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.

TypeResourceDescription
POST/api/projects/:id/buildBuilds a project. Use the Deploy a project build endpoint to deploy the project to an environment.
GET/api/project_builds/:idRetrieves a project build by its unique ID.
GET/api/deployments/:idRetrieves a single deployment by its unique ID.
GET/api/deploymentsRetrieves a list of deployments. Use query parameters to filter results by project, folder, or date range.
GET/api/deployments/:id/eligible_reviewersRetrieves a list of eligible reviewers that can be assigned to review a deployment.
POST/api/deployments/:id/assign_reviewersAssigns reviewers to a deployment.
POST/api/deployments/:id/submit_for_reviewSubmits a deployment for review.
POST/api/deployments/:id/approveApproves a deployment.
POST/api/deployments/:id/rejectRejects a deployment.
POST/api/deployments/:id/reopenRe-opens a deployment for review.
POST/api/deployments/:id/update_review_commentUpdates a deployment review comment.
POST/api/deployments/:id/deployDeploys an approved deployment.