Recipes
Quick reference
| Type | Resource | Description |
|---|---|---|
| GET | /api/recipes/:id | Get recipe details. |
| POST | /api/recipes | Create a recipe. |
| PUT | /api/recipes/:id | Update a recipe. |
| GET | /api/recipes | List recipes belonging to user. |
| GET | /api/recipes/search | Search for public recipes. Requires 'oem_vendor' privilege. |
| PUT | /api/recipes/:id/start | Start recipe. |
| PUT | /api/recipes/:id/stop | Stop recipe. |
| DELETE | /api/recipes/:id | Delete recipe. |
Get recipe details
Returns details about a recipe object.
GET /api/recipes/:id
URL parameters
| Name | Type | Description |
|---|---|---|
| id | integer required |
Recipe ID. |
Sample request
curl -X GET https://workato.com/api/recipes/<recipe_id> \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>'
Response
{
"id": 48,
"user_id": 36,
"name": "Recipe 48",
"created_at": "2015-05-26T22:53:36.904Z",
"updated_at": "2015-05-26T22:53:36.904Z",
"copy_count": 1,
"trigger_application": "custom_adapter",
"action_applications": [
"custom_adapter"
],
"applications": [
"custom_adapter"
],
"description": "Recipe description 48",
"parameters_schema": [
{
"label": "Status",
"name": "status",
"type": "string",
"control_type": "text",
"hint": "new/completed etc"
}
],
"running": false,
"job_succeeded_count": 0,
"job_failed_count": 0,
"last_run_at": null,
"config": [
{
"keyword": "application",
"provider": "custom_adapter",
"name": "custom_adapter",
"account_id": 7
}
],
"author_name": "Test User36"
}
Create a recipe
Creates a recipe in Workato based on parameters in the request.
POST /api/recipes
Request body
| Name | Type | Description |
|---|---|---|
| name | string required |
Name of the recipe. |
| code | string required |
JSON string representing the recipe lines. |
| config | string required |
JSON string representing the connection lines. |
| recipe | hash optional |
The hash of the recipe. |
Sample request
curl -X POST https://workato.com/api/recipes \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Send mail",
"code": "{\"number\":0,\"provider\":\"clock\",\"name\":\"timer\",\"as\":\"timer\",\"keyword\":\"trigger\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"interval\":\"5\",\"start_at\":\"\"},\"block\":[{\"number\":1,\"provider\":\"email\",\"name\":\"send_mail\",\"as\":\"send_mail\",\"keyword\":\"action\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{},\"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\"}]"
}'
Response
{
"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.
PUT /api/recipes/:id
URL parameters
| Name | Type | Description |
|---|---|---|
| id | integer required |
Recipe ID. |
Request body
| Name | Type | Description |
|---|---|---|
| recipe | hash optional |
The hash of the recipe. |
| recipe[name] | string optional |
Name of the recipe. |
| recipe[code] | string optional |
JSON string representing the recipe lines. |
| recipe[config] | string optional |
JSON string representing the connection lines. |
Sample request
curl -X PUT https://workato.com/api/recipes/<recipe_id> \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Send mail",
"code": "{\"number\":0,\"provider\":\"clock\",\"name\":\"timer\",\"as\":\"timer\",\"keyword\":\"trigger\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"interval\":\"5\",\"start_at\":\"\"},\"block\":[{\"number\":1,\"provider\":\"email\",\"name\":\"send_mail\",\"as\":\"send_mail\",\"keyword\":\"action\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{},\"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\"}]"
}'
Response
{
"success": true
}
Note: You cannot update a running recipe.
{
"success": false,
"errors": {
"running": [
"can't modify running recipe"
]
}
}
List recipes belonging to user
Returns a list of recipes belonging to the authenticated user. Recipes are returned in descending ID order.
GET /api/recipes
URL parameters
| Name | Type | Description |
|---|---|---|
| adapter_names_any | string optional |
List of adapters names. Resulting recipes should use at least one of given adapters. |
| adapter_names_all | string optional |
List of adapters names. Resulting recipes should use all of given adapters. |
| active | string optional |
If true, returns running recipes. |
| since_id | integer optional |
Find recipes with ID less than the given ID. |
| order | string optional |
Set ordering method. Possible options: activity, default. |
Sample request
curl -X GET https://workato.com/api/recipes/?adapter_names_any=custom_adapter&custom_adapter1 \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>'
Response
{
"items": [
{
"id": 29,
"user_id": 25,
"name": "Recipe 29",
"created_at": "2015-05-26T22:53:35.802Z",
"updated_at": "2015-05-26T22:53:35.802Z",
"copy_count": 1,
"trigger_application": null,
"action_applications": [
"custom_adapter",
"custom_adapter1"
],
"applications": [
"custom_adapter",
"custom_adapter1"
],
"description": "Recipe description 29",
"parameters_schema": [],
"running": true,
"job_succeeded_count": 16,
"job_failed_count": 2,
"last_run_at": "2015-05-26T22:43:35.793Z",
"config": []
}
]
}
Search for public recipes
Searches for public recipes and returns a list. Returns an empty list when no matching connectors are found.
This requires oem_vendor privilege.
GET /api/recipes/search
URL parameters
| Name | Type | Description |
|---|---|---|
| term | string optional |
Search term. |
| boost_owned | boolean optional |
If true, returned results will give priority to recipes in your account. Defaults to false. |
| page | integer optional |
Page number. Defaults to 0. |
| per_page | integer optional |
Page size. Defaults to 20, max 20. |
Request body
| Name | Type | Description |
|---|---|---|
| applications | string required |
Comma separated connector identifiers (e.g: salesforce,service_now). |
Sample request
curl -X GET https://workato.com/api/recipes/search?per_page=1 \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>' \
-H 'Content-Type: application/json' \
-d '{
"applications": "salesforce,service_now"
}'
Response
{
"items": [
{
"id": 59,
"user_id": 50,
"name": "Recipe 58",
"created_at": "2015-05-26T22:53:39.032Z",
"updated_at": "2015-05-26T22:53:39.032Z",
"copy_count": 1,
"trigger_application": null,
"action_applications": [
"salesforce",
"service_now"
],
"applications": [
"salesforce"
],
"description": "Recipe description 58",
"parameters_schema": []
}
]
}
Start recipe
Starts a recipe specified by recipe ID.
PUT /api/recipes/:id/start
URL parameters
| Name | Type | Description |
|---|---|---|
| id | interger optional |
Recipe ID. |
Sample request
curl -X PUT https://workato.com/api/recipes/<recipe_id>/start \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>'
Response
{
"success": true
}
Stop recipe
Stops a recipe specified by recipe ID.
PUT /api/recipes/:id/stop
URL parameters
| Name | Type | Description |
|---|---|---|
| id | interger optional |
Recipe ID. |
Sample request
curl -X PUT https://workato.com/api/recipes/<recipe_id>/stop \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>'
Response
{
"success": true
}
Delete recipe
Deletes a recipe specified by id.
DELETE /api/recipes/:id
URL parameters
| Name | Type | Description |
|---|---|---|
| id | interger optional |
Recipe ID. |
Sample request
curl -X DELETE https://workato.com/api/recipes/<recipe_id> \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>'
Response
{
"success": true
}