Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Developer API
Resources

Recipes ​

Use this resource to manage recipes programmatically.

Rate limits ​

Recipe resources have the following rate limits:

Quick reference ​

PRIVATE BETA

The following endpoints are in private beta:

Private beta features are available in production but only to selected customers. Customers must opt in and be accepted into the beta.

During the private beta, Workato may update its functionality or change its availability without prior notice.

TypeResourceDescription
GET/api/recipes/:idGet recipe details.
POST/api/recipesCreate a recipe.
POST/api/recipes/:id/copyCopy a recipe.
PUT/api/recipes/:idUpdate a recipe.
GET/api/recipesList recipes belonging to user.
PUT/api/recipes/:id/startStart recipe.
PUT/api/recipes/:id/stopStop recipe.
DELETE/api/recipes/:idDelete recipe.
POST/api/recipes/:recipe_id/reset_triggerReset recipe trigger.
PUT/api/recipes/:recipe_id/connectUpdate connection for an application in a stopped recipe.
POST/api/recipes/:recipe_id/poll_nowActivate a polling trigger for a recipe.
GET/api/recipes/:recipe_id/versionsGet recipe versions.
GET/api/recipes/:recipe_id/versions/:idGet details of a recipe version.
PATCH/PUT/api/recipes/:recipe_id/versions/:idUpdate a recipe version comment.
GET/api/recipes/:recipe_id/healthRetrieve the most recent optimization report for a recipe.
POST/api/recipes/:recipe_id/healthQueue a performance scan using Performance Copilot.

Get recipe details ​

Returns details about a recipe object. Lifetime task count has task data starting from March 19, 2021.

shell
GET /api/recipes/:id

URL parameters ​

NameTypeDescription
idinteger
required		Recipe ID.

Query parameters ​

NameTypeDescription
includes[]array of strings
optional		Specifies additional fields to include in the response. Accepts tags as a value. If tags is supplied in the request, the response includes a tags field for the recipe. This field contains an array of zero or more tag handles (strings).

Sample request ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/12389?includes[]=tags' \
      -H 'Authorization: Bearer <api_token>'

Response ​

json
{
    "id": 12389,
    "user_id": 4848,
    "name": "New webhook call will get JIRA ticket information",
    "created_at": "2016-08-03T11:06:23.950-07:00",
    "updated_at": "2021-11-29T23:31:58.735-08:00",
    "copy_count": 3,
    "trigger_application": "workato_webhooks",
    "action_applications": [
        "jira"
    ],
    "applications": [
        "workato_webhooks",
        "jira"
    ],
    "description": "New webhook call will get JIRA ticket information",
    "project_id": 13595198,
    "parameters_schema": [],
    "parameters": {},
    "folder_id": 4724,
    "running": false,
    "job_succeeded_count": 0,
    "job_failed_count": 0,
    "lifetime_task_count": 0,
    "last_run_at": "2016-08-03T11:06:51.481-07:00",
    "last_job_started_at": "2016-08-03T11:06:45.000-07:00",
    "stopped_at": "2016-08-03T11:22:57.285-07:00",
    "webhook_url": "https://www.workato.com/webhooks/rest/51b6a38f-0102-494d-8290-9d550aeeab3c/webhook_recipe",
    "stop_cause": null,
    "config": [
        {
            "keyword": "application",
            "name": "jira",
            "provider": "jira",
            "skip_validation": false,
            "account_id": null
        },
        {
            "keyword": "application",
            "name": "workato_webhooks",
            "provider": "workato_webhooks",
            "skip_validation": false,
            "account_id": null
        }
    ],
    "trigger_closure": null,
    "code": "...truncated...",
    "version_no": 2,
    "version_author_name": "Jennifer Diaz",
    "version_author_email": "kevin.smith@example.com",
    "version_comment": "Refactored webhook logic to improve error handling and added support for custom JIRA fields",
    "author_name": "Kevin Smith",
    "tags": [
        "tag-ANMNxAz9-oYDJRm",
        "tag-ANgeffPL-3gxQwA"
    ]
}

RESPONSE FIELDS

The last_run_at field returns the timestamp when the recipe most recently started. The last_job_started_at field returns the timestamp when the most recent job for the recipe started. The stopped_at field returns the timestamp when the recipe most recently stopped.

These fields show when the recipe or its most recent job started or stopped. They don't include timestamps for earlier jobs.

The code field returns a JSON string describing the configuration of each recipe step. You can use code as an input for the Create recipe and Update recipe endpoints.

Create a recipe ​

Creates a recipe in Workato based on parameters in the request.

shell
POST /api/recipes

Payload ​

NameTypeDescription
recipeobject
required		The recipe object.
recipe[name]string
optional		Name of the recipe.
recipe[code]string
required		JSON string representing the recipe lines. You can retrieve the code for an existing recipe using the Get recipe details or List recipes belonging to a user endpoint.
recipe[config]string
optional		JSON string representing the connection lines.
recipe[folder_id]string
conditionally required		Folder for the recipe
recipe[description]string
optional		Description of the recipe.

FOLDER_ID REQUIRED STARTING MAY 7, 2026

Starting May 7, 2026, the folder_id parameter is required on this endpoint. The value must reference a project or folder other than the Home assets folder. Requests that omit folder_id or target the Home assets folder will return an error.

Sample request ​

shell
curl  -X POST https://www.workato.com/api/recipes \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
             "recipe": {
               "name":"Send mail",
               "code":"{\"number\":0,\"provider\":\"clock\",\"name\":\"scheduled_event\",\"as\":\"timer\",\"title\":null,\"description\":\"<span class=\\\"provider\\\">Trigger</span> on a <span class=\\\"provider\\\">specified schedule</span>\",\"keyword\":\"trigger\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"time_unit\":\"minutes\",\"trigger_every\":\"5\"},\"extended_input_schema\":[{\"type\":\"string\",\"name\":\"trigger_every\",\"control_type\":\"integer\",\"label\":\"Trigger every\",\"hint\":\"Define repeating schedule. Enter whole numbers only.\\n                        This field can be set to a minimum of 5 minutes.\",\"default\":\"5\",\"optional\":false,\"extends_schema\":true},{\"type\":\"date_time\",\"name\":\"start_after\",\"control_type\":\"date_time\",\"label\":\"Start after\",\"hint\":\"Set date and time to start or leave blank to start immediately. <b>Once recipe has been run or tested, value cannot be changed.</b>\",\"optional\":true,\"extends_schema\":true,\"since_field\":true,\"render_input\":\"date_time_conversion\",\"parse_output\":\"date_time_conversion\"}],\"block\":[{\"number\":1,\"provider\":\"email\",\"name\":\"send_mail\",\"as\":\"send_mail\",\"keyword\":\"action\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"email_type\":\"html\"},\"uuid\":\"cd865246-ece7-4188-845e-33d021664be3\"}],\"uuid\":\"c4b0778d-5a23-4c52-a5bb-4a99ae5d25ae\"}",
               "config":"[{\"keyword\":\"application\",\"name\":\"clock\",\"provider\":\"clock\"},{\"keyword\":\"application\",\"name\":\"email\",\"provider\":\"email\"}]",
               "folder_id": "17254"
            }
          }'

Response ​

json
{
  "success": true,
  "id": 116
}

Update a recipe ​

Updates an existing recipe in Workato specified based on recipe ID. Recipe details are defined based on parameters in the request.

shell
PUT /api/recipes/:id

URL parameters ​

NameTypeDescription
idinteger
required		Recipe ID.

Payload ​

NameTypeDescription
recipeobject
optional		The recipe object.
recipe[name]string
optional		Name of the recipe.
recipe[code]string
optional		JSON string representing the recipe lines. You can retrieve the code for an existing recipe using the Get recipe details or List recipes belonging to a user endpoint.
recipe[config]string
optional		JSON string representing the connection lines.
recipe[folder_id]string
optional		Folder for the recipe
recipe[description]string
optional		Description of the recipe.

Sample request ​

shell
curl  -X PUT 'https://www.workato.com/api/recipes/123421' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
             "recipe": {
               "name":"Send mail",
               "code":"{\"number\":0,\"provider\":\"clock\",\"name\":\"scheduled_event\",\"as\":\"timer\",\"title\":null,\"description\":\"<span class=\\\"provider\\\">Trigger</span> on a <span class=\\\"provider\\\">specified schedule</span>\",\"keyword\":\"trigger\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"time_unit\":\"minutes\",\"trigger_every\":\"5\"},\"extended_input_schema\":[{\"type\":\"string\",\"name\":\"trigger_every\",\"control_type\":\"integer\",\"label\":\"Trigger every\",\"hint\":\"Define repeating schedule. Enter whole numbers only.\\n                        This field can be set to a minimum of 5 minutes.\",\"default\":\"5\",\"optional\":false,\"extends_schema\":true},{\"type\":\"date_time\",\"name\":\"start_after\",\"control_type\":\"date_time\",\"label\":\"Start after\",\"hint\":\"Set date and time to start or leave blank to start immediately. <b>Once recipe has been run or tested, value cannot be changed.</b>\",\"optional\":true,\"extends_schema\":true,\"since_field\":true,\"render_input\":\"date_time_conversion\",\"parse_output\":\"date_time_conversion\"}],\"block\":[{\"number\":1,\"provider\":\"email\",\"name\":\"send_mail\",\"as\":\"send_mail\",\"keyword\":\"action\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"email_type\":\"html\"},\"uuid\":\"cd865246-ece7-4188-845e-33d021664be3\"}],\"uuid\":\"c4b0778d-5a23-4c52-a5bb-4a99ae5d25ae\"}",
               "config":"[{\"keyword\":\"application\",\"name\":\"clock\",\"provider\":\"clock\"},{\"keyword\":\"application\",\"name\":\"email\",\"provider\":\"email\"}]",
               "folder_id": "17254"
             }
          }'

Response ​

json
{
  "success": true
}

UPDATING A RUNNING RECIPE IS PROHIBITED

Any update call to a running recipe will return an error.

Copy a recipe ​

Copy an existing recipe in Workato specified based on recipe ID.

shell
POST /api/recipes/:id/copy

URL parameters ​

NameTypeDescription
idinteger
required		Recipe ID.

Payload ​

NameTypeDescription
folder_idstring
conditionally required		Folder id for the copied recipe

FOLDER_ID REQUIRED STARTING MAY 7, 2026

Starting May 7, 2026, the folder_id parameter is required on this endpoint. The value must reference a project or folder other than the Home assets folder. Requests that omit folder_id or target the Home assets folder will return an error.

Sample request ​

shell
curl  -X POST 'https://www.workato.com/api/recipes/123421/copy' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{"folder_id": "17254"}'

Response ​

json
{
  "success": true,
  "new_flow_id": 39404
}

List recipes belonging to a user ​

Returns a list of recipes belonging to the authenticated user. Recipes are returned in descending ID order.

shell
GET /api/recipes

Query parameters ​

NameTypeDescription
adapter_names_allstring
optional		List of adapters names, separated by commas. Resulting recipes should use all of the given adapters.
adapter_names_anystring
optional		List of adapters names, separated by commas. Resulting recipes should use at least one of the given adapters.
folder_idstring
optional		Return the recipes in the specified folder.
with_subfoldersboolean
optional		If true, includes recipes from subfolders of the folder specified by folder_id. The default is false.
orderstring
optional		Set ordering method. Possible options: activity, default.
pageinteger
optional		Page number (defaults to 1).
per_pageinteger
optional		Specifies the number of recipes to include per page. Defaults to 100. The maximum value is 100.
runningboolean
optional		If true, returns running recipes.
since_idinteger
optional		Use this parameter to retrieve recipes with IDs lower than the ID provided in the request. For example, if since_id=15500, Workato returns all recipes with IDs lower than 15500 (0-14999).
stopped_afterstring
optional		Filter the list of recipes to exclude only those stopped after the date and time you specify. The date and time must be provided in ISO 8601 format according to the following pattern: YYYY-MM-DDTHH:MM:SSZ.
stop_causestring
optional		Reason that the recipe stopped. Possible reasons include — trigger_errors_limit: Recipe was stopped due to consecutive trigger errors action_quota_limit: Customer exceeded plan's task limit trial_expired: Customer's trial expired txn_quota_limit: Customer exceeded plan's job limit
updated_afterstring
optional		Filter the list of recipes to include only those updated after the date and time you specify. The date and time must be provided in ISO 8601 format according to the following pattern: YYYY-MM-DDTHH:MM:SSZ.
includes[]array of strings
optional		Specifies additional fields to include in the response. Accepts tags as a value. If tags is supplied in the request, the response includes a tags field for each recipe. This field contains an array of zero or more tag handles (strings).
exclude_codeboolean
optional		Indicates whether to exclude the recipes' code from the response. This can help avoid timeouts or 500 errors when recipes have complex or lengthy code.

Sample request ​

shell
curl  -X GET 'https://www.workato.com/api/recipes?folder_id=27180380&with_subfolders=true&includes[]=tags' \
      -H 'Authorization: Bearer <api_token>'

Response ​

json
{
    "items": [
        {
            "id": 66876978,
            "user_id": 6471278,
            "name": "Sync new contacts from HubSpot to Mailchimp",
            "created_at": "2025-10-15T13:41:05.207-07:00",
            "updated_at": "2025-10-15T13:41:05.207-07:00",
            "copy_count": 1,
            "trigger_application": "hubspot",
            "action_applications": [
                "mailchimp"
            ],
            "applications": [
                "hubspot",
                "mailchimp"
            ],
            "description": "When a new contact is created in HubSpot, add them to the newsletter list in Mailchimp.",
            "project_id": 13595198,
            "parameters_schema": [],
            "parameters": {},
            "webhook_url": null,
            "folder_id": 27180381,
            "running": false,
            "job_succeeded_count": 0,
            "job_failed_count": 0,
            "lifetime_task_count": 0,
            "last_run_at": null,
            "stopped_at": null,
            "version_no": 1,
            "stop_cause": null,
            "config": [
                {
                    "keyword": "application",
                    "name": "hubspot",
                    "provider": "hubspot",
                    "account_id": 18253670,
                    "skip_validation": false
                },
                {
                    "keyword": "application",
                    "name": "mailchimp",
                    "provider": "mailchimp",
                    "account_id": 18253671,
                    "skip_validation": false
                }
            ],
            "trigger_closure": null,
            "code": "...truncated...",
            "author_name": "Sales",
            "version_author_name": "Alex",
            "version_author_email": "alex@workato.com",
            "version_comment": null,
            "tags": [
                "tag-BNgeffPL-4hxRwB"
            ]
        },
        {
            "id": 66870000,
            "user_id": 6471278,
            "name": "Post Slack notifications when new leads are created in Salesforce",
            "created_at": "2025-10-15T10:47:45.142-07:00",
            "updated_at": "2025-10-15T10:57:36.857-07:00",
            "copy_count": 1,
            "trigger_application": "salesforce",
            "action_applications": [
                "slack"
            ],
            "applications": [
                "salesforce",
                "slack"
            ],
            "description": "1. New lead is created in Salesforce.\n2. Workato posts a message in Slack with the lead details.",
            "project_id": 13595198,
            "parameters_schema": [],
            "parameters": {},
            "webhook_url": null,
            "folder_id": 27180380,
            "running": false,
            "job_succeeded_count": 1,
            "job_failed_count": 0,
            "lifetime_task_count": 3,
            "last_run_at": "2025-10-15T10:51:29.528-07:00",
            "last_job_started_at": "2025-10-15T10:50:00.000-07:00"
            "stopped_at": "2025-10-15T10:54:29.298-07:00",
            "version_no": 6,
            "stop_cause": null,
            "config": [
                {
                    "keyword": "application",
                    "name": "salesforce",
                    "provider": "salesforce",
                    "account_id": 18253669,
                    "skip_validation": false
                },
                {
                    "keyword": "application",
                    "name": "slack",
                    "provider": "slack",
                    "account_id": 18253665,
                    "skip_validation": false
                }
            ],
            "trigger_closure": null,
            "code": "...truncated...",
            "author_name": "Sales",
            "version_author_name": "Alex",
            "version_author_email": "alex@workato.com",
            "version_comment": null,
            "tags": [
                "tag-ANMNxAz9-oYDJRm",
                "tag-ANgeffPL-3gxQwA"
            ]
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

RESPONSE FIELDS

The last_run_at field returns the timestamp when the recipe most recently started. The last_job_started_at field returns the timestamp when the most recent job for the recipe started. The stopped_at field returns the timestamp when the recipe most recently stopped.

These fields show when the recipe or its most recent job started or stopped. They don't include timestamps for earlier jobs.

The code field returns a JSON string describing the configuration of each recipe step. You can use code as an input for the Create recipe and Update recipe endpoints.

Start a recipe ​

Starts a recipe specified by recipe ID.

shell
PUT /api/recipes/:id/start

URL parameters ​

NameTypeDescription
idinteger
optional		Recipe ID.

Sample request ​

shell
curl  -X PUT https://www.workato.com/api/recipes/<recipe_id>/start \
      -H 'Authorization: Bearer <api_token>'

Response ​

json
{
  "success": true
}

Stop a recipe ​

Stops a recipe specified by a recipe ID.

shell
PUT /api/recipes/:id/stop

URL parameters ​

NameTypeDescription
idinteger
optional		Recipe ID.

Sample request ​

shell
curl  -X PUT https://www.workato.com/api/recipes/<recipe_id>/stop \
      -H 'Authorization: Bearer <api_token>'

Response ​

json
{
  "success": true
}

Delete a recipe ​

Delete a recipe specified by ID.

shell
DELETE /api/recipes/:id

URL parameters ​

NameTypeDescription
idinteger
optional		Recipe ID.

Sample request ​

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

Response ​

json
{
  "success": true
}

Reset recipe trigger ​

Reset recipe trigger cursor by recipe ID. Use this endpoint to re-sync data from the source application. The recipe should be designed to handle duplicate records because a re-sync processes every record again. Using this endpoint outside data orchestration scenarios may result in unintended behaviors, including data loss or corruption. Resetting a recipe trigger retains job history and records an event in the recipe's Activity audit log.

If you reset the trigger of an active recipe, Workato completes all jobs with a running, deferred, or pending status first. Then, it proceeds to the new jobs created by the reset trigger.

TRIGGER COMPATIBILITY

This endpoint is only compatible with polling and scheduled triggers. Resetting other triggers may have no effect, or cause unintended behaviors. These triggers include:

  • New CSV file in folder triggers
  • Function triggers
  • API triggers
  • RecipeOps triggers
  • Workbot triggers
  • Deprecated Kafka triggers (compatible with latest triggers)
shell
POST /api/recipes/:recipe_id/reset_trigger

URL parameters ​

NameTypeDescription
recipe_idinteger
required		ID of the recipe to reset.

Sample request ​

shell
curl  -X POST 'https://www.workato.com/api/recipes/91929/reset_trigger' \
      -H 'Authorization: Bearer <api_token>'

Response ​

json
{
    "success": true
}

Update a connection for a recipe ​

Updates the chosen connection for a specific connector in a stopped recipe.

shell
PUT /api/recipes/:recipe_id/connect

URL parameters ​

NameTypeDescription
recipe_idinteger
required		ID of the recipe.

Payload ​

NameTypeDescription
adapter_namestring
required		The internal name of the connector. e.g. salesforce
connection_idinteger
required		The ID of the connection that replaces the existing one.

Sample request ​

shell
curl  -X PUT 'https://www.workato.com/api/recipes/123421/connect' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
          "adapter_name": "salesforce",
          "connection_id": 772461
      }'

Response ​

json
{
    "success": true
}

Activate a polling trigger for a recipe ​

Initiate the polling function of a recipe with polling triggers by providing the recipe ID. This action causes the recipe's polling trigger to execute immediately.

Use the jobs APIs to check the status of a particular recipe.

shell
POST /api/recipes/:recipe_id/poll_now

Path parameters ​

NameTypeDescription
recipe_idinteger
required		The ID of the recipe you plan to start.

Sample request ​

shell
curl  -X POST https://www.workato.com/api/recipes/12345/poll_now \
      -H 'Authorization: Bearer <api_token>'

Response ​

Job started ​

json
{
    "success": true
}

Job already in progress ​

json
{ 
    "message": "Recipe is currently in trigger back off mode till 2023-06-23T23:02" }
}

Error codes ​

NameDescriptionSample reply
404Not found{"success": false, "message": "Not Found"}
429Too many requests. A Retry-After header specifies how long to wait before making a new request.{"message": "Recipe is currently in trigger back off mode till 2023-06-23T11:02"}, or {"message": "Not enough transaction credit"}, or {"message": "Not enough action quota"}
400Bad request{"message":"Trial has expired"}

Get recipe versions ​

Retrieve detailed information about all versions of a specified recipe.

shell
GET /api/recipes/:recipe_id/versions

URL parameters ​

NameTypeDescription
recipe_idstring
required		The ID of the recipe for which you plan to retrieve version details.

Query parameters ​

NameTypeDescription
pageinteger
optional		Page number. Defaults to 1.
per_pageinteger
optional		Page size. Defaults to 100. The maximum is 100.

Sample request ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/12389/versions' \
      -H 'Authorization: Bearer <api_token>'

Response ​

json
{
    "data": [
        {
            "id": 397103,
            "comment": "Updated the recipe to include new Slack channels for onboarding new employees based on their roles",
            "version_no": 2,
            "author_name": "Alex",
            "author_email": "alex@example.com",
            "created_at": "2024-08-03T11:06:23.950-07:00",
            "updated_at": "2024-08-04T23:31:58.735-07:00"
        },
        {
            "id": 392814,
            "comment": "Initial setup of Slack channels for onboarding new employees, including creating channels based on department and role",
            "version_no": 1,
            "author_name": "Alex",
            "author_email": "alex@example.com",
            "created_at": "2024-08-03T11:06:23.950-07:00",
            "updated_at": "2024-08-03T11:06:23.950-07:00"
        }
    ]
}

Get a specific recipe version ​

Retrieve detailed information about a specific recipe version.

shell
GET /api/recipes/:recipe_id/versions/:id

URL parameters ​

NameTypeDescription
recipe_idstring
required		The ID of the recipe for which you plan to retrieve version details.
idstring
required		The ID of the recipe version for which you plan to retrieve details.

Sample request ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/12389/versions/397103' \
      -H 'Authorization: Bearer <api_token>'

Responses ​

200 OK

If successful, the API returns a 200 OK status and a JSON response with the recipe version details:

json
{
    "data": [
        {
            "id": 397103,
            "comment": "Updated the recipe to include new Slack channels for onboarding new employees based on their roles",
            "version_no": 2,
            "author_name": "Alex",
            "author_email": "alex@example.com",
            "created_at": "2024-08-04T23:31:58.735-07:00",
            "updated_at": "2024-08-04T23:31:58.735-07:00"
        }
    ]
}
404 NOT FOUND

The API returns a 404 Not Found error when you provide a non-existent or mismatched value, such as an incorrect recipe ID or version ID:

json
{
    "message": "Not found"
}

Update a recipe version comment ​

Updates the comment on a specific recipe version. This endpoint modifies only the comment associated with the version, not the version itself.

shell
PATCH/PUT /api/recipes/:recipe_id/versions/:id

URL parameters ​

NameTypeDescription
recipe_idstring
required		The ID of the recipe for which you plan to retrieve version details.
idstring
required		The ID of the recipe version for which you plan to update the comment.

Payload ​

NameTypeDescription
commentstring
required		The new comment for the recipe version. Must be 255 characters or fewer.

Sample request ​

shell
curl  -X PATCH 'https://www.workato.com/api/recipes/12389/versions/397103' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
                "comment": "Refined the Slack channel setup for onboarding to ensure channels are created accurately based on employee roles and departments"
           }'

Responses ​

200 OK

If successful, the API returns a 200 OK status and a JSON response with the updated recipe version details:

json
{
    "data": [
        {
            "id": 397103,
            "comment": "Refined the Slack channel setup for onboarding to ensure channels are created accurately based on employee roles and departments",
            "version_no": 2,
            "author_name": "Alex",
            "author_email": "alex@example.com",
            "created_at": "2024-08-04T23:31:58.735-07:00",
            "updated_at": "2024-08-07T23:31:58.735-07:00"
        }
    ]
}
404 NOT FOUND

The API returns a 404 Not Found error when you provide a non-existent or mismatched value, such as an incorrect recipe ID or version ID:

json
{
    "message": "Not found"
}
422 UNPROCESSABLE ENTITY

The API returns a 422 Unprocessable Entity error in the following scenarios:

Comment exceeds 255 characters ​

This error occurs when the recipe version comment exceeds 255 characters:

json
{
  "errors": [
        {
            "code": "validation_error",
            "title": "Comment is too long (maximum is 255 characters)",
            "detail": null
        }
    ]
}

Missing comment ​

This error occurs when the recipe version comment is missing from the request payload:

json
{
  "errors": [
        {
            "code": "validation_error",
            "title": "Missing parameter comment",
            "detail": null
        }
    ]
}

Get recipe health ​

This endpoint retrieves the most recent optimization report for a recipe. The report includes checks run by Performance Copilot, rule violations, and a total score.

shell
GET /api/recipes/:recipe_id/health

NO OPTIMIZATION DATA

You must run a scan using the recipe editor or the API to generate a performance report. If you don't run a scan, this endpoint returns null.

URL parameters ​

NameTypeDescription
recipe_idinteger
required		The ID of the recipe to retrieve performance data for.

Sample request ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/12389/health' \
      -H 'Authorization: Bearer <api_token>'

Response ​

This endpoint returns the latest performance report for the recipe. The report includes the following information:

  • A list of checks with associated rules
  • Rule violations with explanations and suggestions
  • A summary report with total score and impact breakdown

In the response, each rule includes a uuid that uniquely identifies it, and each violation has its own uuid to identify the specific instance. An empty violations array means no issues were found for that rule. A non-empty array indicates one or more violations.

json
{
    "data": {
        "checks": [
            {
                "rule": {
                    "uuid": "067e2484-fe30-76b3-8000-2434f39f5b38",
                    "title": "Redundant Logging",
                    "category": "cost",
                    "impact": "low",
                    "effort": "low",
                    "level": "single_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "01960e61-71ec-77d1-bd0f-6cbe8c830a28",
                    "title": "Using deprecated trigger",
                    "category": "performance",
                    "impact": "high",
                    "effort": "medium",
                    "level": "single_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "01963843-d38b-7563-b55e-743ab422f523",
                    "title": "Missing error handling",
                    "category": "quality",
                    "impact": "medium",
                    "effort": "low",
                    "level": "multi_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "067e2486-e64b-704a-8000-dc8b1345d458",
                    "title": "Unused Variable Detection",
                    "category": "cost",
                    "impact": "low",
                    "effort": "low",
                    "level": "single_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "067e247e-0feb-7e9c-8000-3ebb0e739bcb",
                    "title": "Error handling block with no actions",
                    "category": "quality",
                    "impact": "medium",
                    "effort": "low",
                    "level": "single_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "067e2483-75cd-7df8-8000-f5d2b6b8c29c",
                    "title": "Recipe too long",
                    "category": "quality",
                    "impact": "medium",
                    "effort": "medium",
                    "level": "recipe",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "067e2485-f748-7ecd-8000-f11fdbb50534",
                    "title": "Using deprecated action",
                    "category": "performance",
                    "impact": "high",
                    "effort": "medium",
                    "level": "single_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "019623c4-ce85-7952-93c2-3236982732a7",
                    "title": "Missing recipe description",
                    "category": "quality",
                    "impact": "low",
                    "effort": "low",
                    "level": "recipe",
                    "is_copilot_reparable": false
                },
                "violations": [
                    {
                        "uuid": "572d474c-e775-488b-b4ac-339642bf6c5f",
                        "explanation": "Recipes without clear descriptions are difficult for team members to understand, maintain, and troubleshoot, creating knowledge silos and increasing support overhead.",
                        "suggestion": "Add a comprehensive description outlining the recipe's purpose, business context, dependencies, and any special considerations for future maintainers.",
                        "level": "recipe",
                        "locations": []
                    }
                ]
            },
            {
                "rule": {
                    "uuid": "067e2482-44d1-7697-8000-d7d3acaf92ab",
                    "title": "Inefficient job filtering",
                    "category": "performance",
                    "impact": "medium",
                    "effort": "low",
                    "level": "multi_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            },
            {
                "rule": {
                    "uuid": "067e2465-6330-75c8-8000-90900aaf09c1",
                    "title": "Consecutive Variable Declaration",
                    "category": "cost",
                    "impact": "medium",
                    "effort": "low",
                    "level": "multi_step",
                    "is_copilot_reparable": false
                },
                "violations": []
            }
        ],
        "report": {
            "total_score": 95,
            "impact": {
                "low": {
                    "total": 3,
                    "broken_rules": 1,
                    "violations": 1,
                    "weight": 2
                },
                "medium": {
                    "total": 5,
                    "broken_rules": 0,
                    "violations": 0,
                    "weight": 5
                },
                "high": {
                    "total": 2,
                    "broken_rules": 0,
                    "violations": 0,
                    "weight": 8
                },
                "critical": {
                    "total": 0,
                    "broken_rules": 0,
                    "violations": 0,
                    "weight": 10
                }
            },
            "completed_at": "2025-04-25T15:42:55.279Z"
        },
        "version": 1
    }
}

Start analyzing recipe health ​

This endpoint queues a recipe for analysis by Performance Copilot. Use this endpoint to request a new performance scan after making changes to the recipe.

shell
POST /api/recipes/:recipe_id/health

URL parameters ​

NameTypeDescription
recipe_idinteger
required		The ID of the recipe to scan for performance issues.

Sample request ​

shell
curl  -X POST 'https://www.workato.com/api/recipes/12389/health' \
      -H 'Authorization: Bearer <api_token>'

Response ​

The response confirms that the recipe has been successfully queued for analysis.

json
{
    "status": "enqueued"
}

Use the Get recipe health endpoint to retrieve the performance report after analysis is complete.

Last updated: