Developer APIResources

Recipes

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/recipesList recipes belonging to a user.
POST/api/recipesCreate a recipe.
DELETE/api/recipes/:recipe_idDelete a recipe.
GET/api/recipes/:recipe_idGet recipe details.
PUT/api/recipes/:recipe_idUpdate a recipe.
PUT/api/recipes/:recipe_id/connectUpdate connection for an application in a stopped recipe.
POST/api/recipes/:recipe_id/copyCopy a recipe.
POST/api/recipes/:recipe_id/poll_nowActivate a polling trigger for a recipe. This forces a running recipe to immediately poll.
POST/api/recipes/:recipe_id/reset_triggerReset recipe trigger.
PUT/api/recipes/:recipe_id/startStart a recipe.
PUT/api/recipes/:recipe_id/stopStop 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.