Recipe Lifecycle Management ​

• Manifest: A container of different assets, including recipes, lookup tables, connections, and more.

• Package: The build of a manifest. Contains the source code of each asset within a manifest. It includes the latest version of the asset available when the package was created.

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/export_manifests/folder_assets

URL parameters ​

Sample request ​

curl -X GET 'https://www.workato.com/api/export_manifests/folder_assets?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,
        "status": "added"
      },
      {
        "id": 13,
        "name": "My Salesforce account",
        "type": "connection",
        "version": 2,
        "folder": "Salesforce Integration Project",
        "absolute_path": "Salesforce Integration Project",
        "root_folder": false,
        "unreachable": false,
        "zip_name": "salesforce_account_v2.connection.json",
        "checked": true,
        "status": "updated"
      },
      {
        "id": 14,
        "name": "Submit request in New workflow app",
        "type": "page",
        "version": 1,
        "folder": "Workflow Automation Project",
        "absolute_path": "Workflow Automation Project",
        "root_folder": false,
        "unreachable": false,
        "zip_name": "submit_request_workflow_app.page.json",
        "checked": true,
        "status": "no change"
      }
    ]
  }
}

Create an export manifest ​

Create an export manifest.

POST /api/export_manifests

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/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
            }
          }'

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"
  }
}

curl  -X POST 'https://www.workato.com/api/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 adding the include_test_cases and include_data parameters. Note that test cases and data 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/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/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/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
            }
          }
          '

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"
  }
}

curl  -X POST 'https://www.workato.com/api/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 adding the include_test_cases and include_data parameters. Note that test cases and data 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/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/export_manifests/:id

URL parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/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/export_manifests/:id

URL parameters ​

Sample request ​

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

Response ​

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

Export a package based on a manifest ​

Export a package based on a manifest.

POST /api/packages/export/:id

This is an asynchronous request. Use GET package by ID endpoint to get details of the exported package.

URL parameters ​

Sample request ​

curl  -X POST 'https://www.workato.com/api/packages/export/<manifest_id>' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
  "id": 242,
  "operation_type": "export",
  "status": "in_progress",
  "include_tags": true,
  "export_manifest_id": 3,
  "download_url": null
}

Import a package into a folder ​

Import a package in zip file format into a folder. 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/packages/import/:id

This is an asynchronous request. Use GET package by ID endpoint to get details of the imported the package.

The input (zip file) is a application/octet-stream payload containing package content. URL parameter restart_recipes must be 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/packages/import/<folder_id>?restart_recipes=true&include_tags=true' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/octet-stream' \
      --data-binary @'path/to/local/file.zip'

Response ​

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

Get package by ID ​

Get details of an imported or exported package.

GET /api/packages/:id

URL parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/packages/242' \
      -H 'Authorization: Bearer <api_token>'

Responses ​

• Successful export
• Failed export
• Successful import
• Failed import

Successful export ​

This response shows the result of retrieving a completed export manifest.

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

Failed export ​

This response shows the result of retrieving a failed export manifest.

{
   "id":242,
   "operation_type":"export",
   "status":"failed",
   "error":"error_message",
   "export_manifest_id":4,
   "download_url":null
}

Successful import ​

This response shows the result of retrieving a completed import package. The API response now includes recipe_status.id values immediately after the first import operation. Previously, the response contained only the IDs of updated recipes. Now, it includes the IDs of all recipes, including newly imported recipes. This response specifically returns only recipe IDs, not IDs of other assets within the package.

{
   "id": 242,
   "operation_type": "import",
   "status": "completed",
   "download_url": "https://www.workato-staging-assets.com/packages/zip_files/000/000/242/original/importdemo.zip",
   "recipe_status": [
      {
            "id": 12345,
            "import_result": "no_update_or_updated_without_restart"
      },
      {
            "id": 12346,
            "import_result": "restarted"
      },
      {
            "id": 12347,
            "import_result": "stopped"
      }
   ]
}

Failed import ​

This response shows the result of retrieving a failed import package.

{
   "id": 242,
   "operation_type": "import",
   "status": "failed",
   "download_url": "https://www.workato-staging-assets.com/packages/zip_files/000/000/242/original/importdemo.zip",
   "recipe_status": [
      {
            "id": 12345,
            "import_result": "restart_failed"
      },
      {
            "id": 12346,
            "import_result": "restart_failed"
      },
      {
            "id": 12347,
            "import_result": "restart_failed"
      }
   ]
}

Recipe import_result values ​

There are a total of six possible results:

• no_update_or_updated_without_restart

• 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

Download package ​

Downloads a package.

GET /api/packages/:id/download

URL parameters ​

Sample request ​

curl  -L -X GET 'https://www.workato.com/api/packages/<package_id>/download' \
      -H 'Authorization: Bearer <api_token>'

Response ​

If successful, you will be redirected to the package content. Returns 404 if package not found or doesn't have content.