Recipe lifecycle management ​

The following endpoints are available to Embedded partners only. These endpoints allow you to create and manage export manifests programmatically. You can also use these endpoints to import and export a package to or from a customer workspace using one set of API credentials.

If you plan to import or export packages to or from your own environments (not customer workspaces), use the endpoints listed in the Developer API documentation.

Rate limits ​

Recipe lifecycle management resources have the following rate limits:

Quick reference ​

View assets in a folder ​

View assets in a folder. You can use this endpoint to help you create or update an export manifest.

GET /api/managed_users/:managed_user_id/export_manifests/folder_assets

URL parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/managed_users/91928/export_manifests?folder_id=423' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
  "result": {
    "assets": [
      {
        "id": 12,
        "name": "Copy of Recipeops",
        "type": "recipe",
        "version": 1,
        "folder": "",
        "absolute_path": "All projects",
        "root_folder": false,
        "unreachable": false,
        "zip_name": "copy_of_recipeops.recipe.json",
        "checked": true
      }
    ]
  }
}

Create an export manifest ​

Create an export manifest.

POST /api/managed_users/:managed_user_id/export_manifests

URL parameters ​

Payload ​

Asset types ​

Supported asset type values include:

• recipe
• connection
• lookup_table
• workato_db_table
• account_property
• project_property
• workato_schema
• workato_template
• lcap_app
• lcap_page
• custom_adapter
• topic
• connection
• recipe
• api_group
• api_endpoint

Sample request ​

curl  -X POST 'https://www.workato.com/api/managed_users/91928/export_manifests' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "assets": [
                {
                  "id": 12,
                  "name": "Copy of Recipeops",
                  "type": "recipe",
                  "version": 1,
                  "folder": "",
                  "absolute_path": "All projects",
                  "root_folder": false,
                  "unreachable": false,
                  "zip_name": "copy_of_recipeops.recipe.json",
                  "checked": true
                }
              ],
              "folder_id": 112,
              "include_tags": true
            }
          }'

curl  -X POST 'https://www.workato.com/api/managed_users/45267/export_manifests' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest with two assets",
              "assets": [
                {
                   "id": 65008167,
                   "name": "Outreach",
                   "type": "connection",
                   "version": null,
                   "folder": "API tests",
                   "absolute_path": "All projects/API tests",
                   "root_folder": false,
                   "provider": "outreach",
                   "unreachable": false,
                   "zip_name": "API tests/outreach.connection.json",
                   "deps": [],
                   "checked": true
                },
                {
                    "id": 86330482,
                    "name": "Test recipe",
                    "type": "recipe",
                    "version": 4,
                    "folder": "API tests",
                    "absolute_path": "All projects/API tests",
                    "root_folder": false,
                    "include_test_cases": false,
                    "unreachable": false,
                    "zip_name": "API tests/test_recipe.recipe.json",
                    "deps": [],
                    "checked": true
                  }
              ],
              "folder_id": 21339705,
              "include_tags": true
              }
            }'

{
    "result": {
        "id": 267546,
        "name": "Test Manifest with two assets",
        "created_at": "2025-03-21T07:50:29.488-07:00",
        "updated_at": "2025-03-21T07:50:29.488-07:00",
        "deleted_at": null,
        "last_exported_at": null,
        "project_path": "Home assets",
        "status": "working",
        "include_tags": true
    }
}

Auto-generate assets ​

If you plan for Workato to auto-generate your assets, you can pass the parameter auto_generate_assets into the payload of the request. You must specify the folder_id you plan to have auto-generated. You can also choose to include test cases and data by including the include_test_cases or include_data parameters. Otherwise, they are excluded by default. Additionally, you can include auto_run in the payload to generate the package automatically.

Sample request ​

curl  -X POST 'https://www.workato.com/api/managed_users/91928/export_manifests' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "folder_id": 112,
              "auto_generate_assets": true,
              "include_test_cases": true,
              "include_data": true, 
              "auto_run": true
            }
          }'

Response ​

{
  "result": {
    "id": 12,
    "name": "Test Manifest",
    "last_exported_at": null,
    "created_at": "2023-02-27T02:44:59.447-08:00",
    "updated_at": "2023-02-27T02:44:59.447-08:00",
    "deleted_at": null,
    "project_path": "Folder 1",
    "status": "working"
  }
}

Possible statuses ​

Update an export manifest ​

Update an export manifest.

PUT /api/managed_users/:managed_user_id/export_manifests/:id

URL parameters ​

Payload ​

Update the properties contained in assets[] to replace the assets previously defined.

Asset types ​

Supported asset type values include:

• recipe
• connection
• lookup_table
• workato_db_table
• account_property
• project_property
• workato_schema
• workato_template
• lcap_app
• lcap_page
• custom_adapter
• topic
• connection
• recipe
• api_group
• api_endpoint

Sample request ​

curl  -X PUT 'https://www.workato.com/api/managed_users/91928/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "assets": [
                {
                  "id": 12,
                  "name": "Copy of Recipeops",
                  "type": "recipe",
                  "version": 1,
                  "folder": "",
                  "absolute_path": "All projects",
                  "root_folder": false,
                  "unreachable": false,
                  "zip_name": "copy_of_recipeops.recipe.json",
                  "checked": true
                }
              ],
              "folder_id": 112
            }
          }
          '

curl  -X POST 'https://www.workato.com/api/managed_users/91928/export_manifests/15' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest with two assets",
              "assets": [
                {
                   "id": 65008167,
                   "name": "Outreach",
                   "type": "connection",
                   "version": null,
                   "folder": "API tests",
                   "absolute_path": "All projects/API tests",
                   "root_folder": false,
                   "provider": "outreach",
                   "unreachable": false,
                   "zip_name": "API tests/outreach.connection.json",
                   "deps": [],
                   "checked": true
                },
                {
                    "id": 86330482,
                    "name": "Test recipe",
                    "type": "recipe",
                    "version": 4,
                    "folder": "API tests",
                    "absolute_path": "All projects/API tests",
                    "root_folder": false,
                    "include_test_cases": false,
                    "unreachable": false,
                    "zip_name": "API tests/test_recipe.recipe.json",
                    "deps": [],
                    "checked": true
                  }
              ],
              "folder_id": 21339715
              }
            }'

{
    "result": {
        "id": 171350,
        "name": "Test Manifest with two assets",
        "created_at": "2025-03-19T07:45:50.915-07:00",
        "updated_at": "2025-03-21T09:26:46.348-07:00",
        "deleted_at": null,
        "last_exported_at": null,
        "project_path": "Home assets",
        "status": "working",
        "include_tags": true,
        "assets": [
            {
                "checked": true,
                "root_folder": false,
                "unreachable": false,
                "name": "Outreach",
                "zip_name": "API tests/outreach.connection.json",
                "id": 65008167,
                "type": "connection",
                "version": null,
                "folder": "API tests",
                "absolute_path": "All projects/API tests",
                "deps": []
            },
            {
                "checked": true,
                "root_folder": false,
                "unreachable": false,
                "name": "Test recipe",
                "zip_name": "API tests/test_recipe.recipe.json",
                "id": 86330482,
                "type": "recipe",
                "version": 4,
                "folder": "API tests",
                "absolute_path": "All projects/API tests",
                "include_test_cases": false,
                "deps": []
            }
        ],
        "diff_included": false
    }
}

Auto-generate assets ​

If you plan for Workato to auto-generate your assets, you can pass the parameter auto_generate_assets into the payload of the request. You must specify the folder_id you plan to have auto-generated. You can also choose to include test cases and data by including the include_test_cases or include_data parameters. Otherwise, they are excluded by default. Additionally, you can include auto_run in the payload to generate the package automatically.

Sample request ​

curl  -X PUT 'https://www.workato.com/api/managed_users/91928/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "folder_id": 112,
              "auto_generate_assets": true,
              "include_test_cases": true,
              "include_data": true, 
              "auto_run": true
            }
          }
          '

Response ​

{
  "result": {
    "id": 12,
    "name": "Test Manifest",
    "last_exported_at": null,
    "created_at": "2023-02-27T02:44:59.447-08:00",
    "updated_at": "2023-02-27T02:44:59.447-08:00",
    "deleted_at": null,
    "project_path": "Folder 1",
    "status": "working"
  }
}

View an export manifest ​

View an export manifest.

GET /api/managed_users/:managed_user_id/export_manifests/:id

URL parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/managed_users/91928/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
  "result": {
    "id": 12,
    "name": "Test Manifest",
    "last_exported_at": null,
    "created_at": "2023-02-27T02:44:59.447-08:00",
    "updated_at": "2023-02-27T02:44:59.447-08:00",
    "deleted_at": null,
    "project_path": "Folder 1",
    "status": "working"
  }
}

Delete an export manifest ​

Delete an export manifest.

DELETE /api/managed_users/:managed_user_id/export_manifests/:id

URL parameters ​

Sample request ​

curl  -X DELETE 'https://www.workato.com/managed_users/12345/api/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
    "result": {
        "success": true,
        "status": "destroyed"
    }
}

Import package into a customer workspace ​

Import a package in zip file format into a specified folder in a customer workspace. This endpoint allows an API client to create or update assets, such as recipes, lookup tables, event topics, and message templates, through package imports.

POST /api/managed_users/:managed_user_id/imports

This is an asynchronous request. Use the Get package status endpoint to get details of the imported the package.

The input (zip file) is an application/octet-stream payload containing package content. The query parameter restart_recipes must be set to true if the running recipes need to be restarted upon import.

URL parameters ​

Query parameters ​

Sample request ​

curl  -X POST 'https://www.workato.com/api/managed_users/91928/imports?folder_id=1827&include_tags=true' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/octet-stream' \
      -F 'path/to/local/file.zip'

Response ​

{  
   "id":251,
   "operation_type":"import",
   "status":"completed"
}

Get status of package import ​

Get details of a package imported into a customer workspace.

GET /api/managed_users/:managed_user_id/imports/:package_id

URL parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/managed_users/91829/imports/198' \
      -H 'Authorization: Bearer <api_token>'

Responses ​

• Successful import
• Failed import

Successful import ​

The following response is returned when an import is completed successfully.

{
   "id":242,
   "operation_type":"export",
   "status":"completed",
   "recipe_status":[
      {
            "id": 12345,
            "import_result": "no_update_or_update_without_restart"
      },
      {
            "id": 12346,
            "import_result": "restarted"
      },
      {
            "id": 12347,
            "import_result": "stopped"
      }
   ]
}

Failed import ​

The following response is returned when an import fails.

{  
   "id":198,
   "operation_type":"export",
   "status":"failed",
   "error":"error_message",
   "recipe_status":[
      {
            "id": 12345,
            "import_result": "no_update_or_update_without_restart"
      },
      {
            "id": 12346,
            "import_result": "restarted"
      },
      {
            "id": 12347,
            "import_result": "stopped"
      }
   ]
}

Recipe import_result values ​

There are a total of six (6) possible results:

• no_update_or_update_without_restart - This indicates no restart was needed for the recipe. Either recipe could be updated without it or no update was made. Successful import
• not_found - Unexpected error when recipe cannot be found. Should not often be seen. Import has failed with no update to recipe.
• stop_failed - For recipes that need to be restarted, we attempt to stop the recipe. This state indicates we could not stop the recipe. Import has failed with no update to recipe.
• stopped - Workato stopped the recipe but recipe was not restarted due to errors in the recipe. Import has failed with recipe updated but not restarted
• restart_failed - Workato attempted to restart recipe but failed to do so. Import has failed with recipe updated but not restarted
• restarted - Workato successfully restarted recipe after update. Successful import

Export package ​

Export a package using the manifest ID. This endpoint requires an Embedded workspace.

Use the Get export status endpoint to retrieve details on the exported package.

POST /api/managed_users/:managed_user_id/exports/:manifest_id

URL parameters ​

Sample request ​

curl  -X POST 'https://www.workato.com/api/managed_users/91829/exports/508' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
  "id": 365,
  "operation_type": "export",
  "status": "in_progress",
  "include_tags": true,
  "export_manifest_id": 508,
  "download_url": null
}

Get export status ​

Returns the status of an exported package. Requires an Embedded workspace.

GET /api/managed_users/:managed_user_id/exports/:package_id

URL parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/managed_users/91829/exports/370' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
      "id":370,
      "operation_type":"export",
      "status":"completed",
      "export_manifest_id":513,
      "download_url":"https://www.workato-staging-assets.com/packages/zip_files/000/000/242/original/exportdemo.zip"
}