Workato integration

Lets your app list the recipes in a Workato workspace, start or stop one, read its jobs and list connections.

Connecting

On the Integrations page choose Connect on Workato and fill in:

• Data centre — The host you sign in at: www.workato.com (US), app.eu.workato.com, app.jp.workato.com, app.sg.workato.com or app.au.workato.com.
• API client token — Workato → Workspace admin → API clients → Create API client. Give its role the Recipes and Jobs permissions.

Sapilon checks the key with the provider before it saves it, and stores it encrypted; it is never shown again.

What your app can do

Only these requests are available; anything else is refused.

• GET /users/me
• GET /recipes
• GET /recipes/*
• PUT /recipes/*/start
• PUT /recipes/*/stop
• GET /recipes/*/jobs
• GET /connections

How the agent uses it

Use integrations.request('workato', …); paths are relative to https://<data centre>/api.

• GET /users/me — the workspace.
• GET /recipes (query: { running: 'true' }), GET /recipes/{id}.
• PUT /recipes/{id}/start, PUT /recipes/{id}/stop — Example: { method: 'PUT', path: '/recipes/1913/start' }; the answer says success, or lists the problems that keep it from starting.
• GET /recipes/{id}/jobs — recent jobs and whether they succeeded.
• GET /connections — the workspace’s connections and whether they are authorised.

Editing or deleting recipes is not allowed.

More from Workato: https://docs.workato.com/workato-api.html