Workato API 1.0

Workato's REST API provides you with access to Workato resources. With this, you can manage recipes, connections and jobs programmatically to expand the functionality of your Workato account. This API also allows you to auther new recipes and modify existing ones.

Authentication

All API requests must contain:

  • X-USER-TOKEN and X-USER-EMAIL in the request headers OR
  • user_token & user_email in the query parameters

The user_token/X-USER-TOKEN can be found in your settings page. Alternatively, navigate to your account settings by clicking on Account Settings in the dropdown of the top right of your homepage in Workato. Your API key can be found in the left navigation panel in the subsequent page.

Workato API Resource Overview

Workato's API has various endpoints that allows access functionality to different aspects of Workato. Here is a general overview of the endpoints available.

Adapters

Resource Description
GET /api/integrations Query connector metadata. Requires 'oem_vendor' privilege.

Connections

Resource Description
GET /api/connections List connections belonging to user

Jobs

Resource Description
GET /api/recipes/:recipe_id/jobs List jobs belonging to recipe

Managed Users

Resource Description
POST /api/managed_users Create a new OEM user. Requires 'oem_vendor' privilege.
POST /api/managed_users/:id/member Add member to the OEM account. Requires 'oem_vendor' privilege.

Recipes

Resource Description
GET /api/recipes/:id Get recipe details
POST /api/recipes Create recipe
PUT /api/recipes/:id Update 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

Users

Resource Description
GET /api/users/me Get details of authenticated user

Recipe lifecycle management

Resource Description
POST /api/packages/export/:manifest_id Export package based on a manifest
POST /api/packages/import/:folder_id Import package into a folder
GET /api/packages/:id Get package by ID
GET /api/packages/:id/download Download package

results matching ""

    No results matching ""