> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workato

> How to set up the Workato connector, plus the actions that are available.

![Workato](https://stackone-logos.com/api/workato/filled/svg)

Previewv0.3.0[See changelog](https://docs.stackone.com/connectors/workato/changelog.md)

[360 actions](#actions) · 1 auth method

Automation
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Client Token · Connector Profile](https://docs.stackone.com/connectors/workato/guides/connector-profile/api-client-token.md)
>
> Requires creating an API client in Workato Workspace admin. The token can call only the endpoints its client role lists,...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Client Token · Link Account](https://docs.stackone.com/connectors/workato/guides/link-account/api-client-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

360 actions

ActionDescription

List Genies`workato_list_genies`

List the genies of the Workato workspace.

Create Genie`workato_create_genie`

Create a genie in the Workato workspace.

Get Genie`workato_get_genie`

Get a single Workato genie.

Update Genie`workato_update_genie`

Update a Workato genie.

Delete Genie`workato_delete_genie`

Delete a Workato genie.

Start Genie`workato_start_genie`

Start a Workato genie.

Stop Genie`workato_stop_genie`

Stop a Workato genie.

Assign Genie Skills`workato_assign_genie_skills`

Give a Workato genie skills or MCP servers.

Remove Genie Skills`workato_remove_genie_skills`

Take skills off a Workato genie.

Assign Genie Knowledge Bases`workato_assign_genie_knowledge_bases`

Give a Workato genie knowledge bases.

Remove Genie Knowledge Bases`workato_remove_genie_knowledge_bases`

Take knowledge bases off a Workato genie.

Assign Genie User Groups`workato_assign_genie_user_groups`

Give user groups access to a Workato genie.

Remove Genie User Groups`workato_remove_genie_user_groups`

Take user groups off a Workato genie.

List Genie Clients`workato_list_genie_clients`

List the custom clients of Workato genies.

Create Genie Client`workato_create_genie_client`

Create a custom client for Workato genies.

Get Genie Client`workato_get_genie_client`

Get a single Workato genie client.

Update Genie Client`workato_update_genie_client`

Update a Workato genie client.

Delete Genie Client`workato_delete_genie_client`

Delete a Workato genie client.

Regenerate Genie Client Key`workato_regenerate_genie_client_key`

Rotate the API key of a Workato genie client.

Pause Genie Client`workato_pause_genie_client`

Pause a Workato genie client.

Start Genie Client`workato_start_genie_client`

Start a paused Workato genie client.

Attach Genie Client`workato_attach_genie_client`

Attach a custom client to a Workato genie.

Detach Genie Client`workato_detach_genie_client`

Detach a custom client from a Workato genie.

List Genie Chat Interfaces`workato_list_genie_interfaces`

List the chat interface triggers of a Workato genie.

List Genie Conversations`workato_list_genie_conversations`

List the conversations of a Workato genie.

Get Genie Conversation`workato_get_genie_conversation`

Get a single conversation of a Workato genie.

List Genie Conversation Events`workato_list_genie_conversation_events`

List the events of a Workato genie conversation.

Get Genie Guardrail`workato_get_genie_guardrail`

Get the guardrail of a Workato genie.

Upsert Genie Guardrail Policy`workato_upsert_genie_guardrail_policy`

Create or update one policy on a Workato genie guardrail.

List PII Entity Types`workato_list_pii_entity_types`

List the personal data types a Workato guardrail can detect.

List Knowledge Bases`workato_list_knowledge_bases`

List the knowledge bases of the Workato workspace.

Create Knowledge Base`workato_create_knowledge_base`

Create a knowledge base in the Workato workspace.

Get Knowledge Base`workato_get_knowledge_base`

Get a single Workato knowledge base.

Update Knowledge Base`workato_update_knowledge_base`

Update a Workato knowledge base.

Delete Knowledge Base`workato_delete_knowledge_base`

Delete a Workato knowledge base.

Get Knowledge Base Data Sources`workato_get_knowledge_base_data_sources`

List the data sources of a Workato knowledge base.

Get Knowledge Base Recipes`workato_get_knowledge_base_recipes`

List the recipes tied to a Workato knowledge base.

List Skills`workato_list_skills`

List the skills of the Workato workspace.

Create Skill`workato_create_skill`

Turn a Workato recipe into a genie skill.

Get Skill`workato_get_skill`

Get a single Workato genie skill.

List API Clients`workato_list_api_clients`

List the API clients of the Workato workspace.

Create API Client`workato_create_api_client`

Create a Developer API client in the Workato workspace.

Get API Client`workato_get_api_client`

Get a Developer API client of the Workato workspace.

Update API Client`workato_update_api_client`

Update a Developer API client of the Workato workspace.

Delete API Client`workato_delete_api_client`

Delete a Developer API client from the Workato workspace.

Regenerate API Client Token`workato_regenerate_api_client_token`

Replace the API token of a Workato Developer API client.

List API Client Roles`workato_list_api_client_roles`

List the Developer API client roles of the Workato workspace.

List API Collections`workato_list_api_collections`

List the API collections of the Workato workspace.

Create API Collection`workato_create_api_collection`

Create an API collection in a Workato project.

Update API Collection`workato_update_api_collection`

Update a Workato API collection.

Delete API Collection`workato_delete_api_collection`

Delete a Workato API collection.

Get API Collection OpenAPI Spec`workato_get_api_collection_openapi`

Get the OpenAPI specification of a Workato API collection.

List API Endpoints`workato_list_api_endpoints`

List the API endpoints of the Workato workspace.

Create API Endpoint`workato_create_api_endpoint`

Create an endpoint in a Workato API collection.

Update API Endpoint`workato_update_api_endpoint`

Update an endpoint of a Workato API collection.

Enable API Endpoint`workato_enable_api_endpoint`

Enable a Workato API endpoint.

Disable API Endpoint`workato_disable_api_endpoint`

Disable a Workato API endpoint.

Get API Endpoint OpenAPI Spec`workato_get_api_endpoint_openapi`

Get the OpenAPI specification of a single Workato API endpoint.

List API Platform Clients`workato_list_api_platform_clients`

List the API platform clients of the Workato workspace.

Create API Platform Client`workato_create_api_platform_client`

Create an API platform client in the Workato workspace.

Get API Platform Client`workato_get_api_platform_client`

Get a single Workato API platform client.

Update API Platform Client`workato_update_api_platform_client`

Update a Workato API platform client.

Delete API Platform Client`workato_delete_api_platform_client`

Delete a Workato API platform client.

List API Keys`workato_list_api_keys`

List the API keys of a Workato API platform client.

Create API Key`workato_create_api_key`

Create an API key for a Workato API platform client.

Update API Key`workato_update_api_key`

Update an API key of a Workato API platform client.

Enable API Key`workato_enable_api_key`

Enable an API key of a Workato API platform client.

Disable API Key`workato_disable_api_key`

Disable an API key of a Workato API platform client.

Refresh API Key Secret`workato_refresh_api_key_secret`

Replace the secret of a Workato API key.

Delete API Key`workato_delete_api_key`

Delete an API key of a Workato API platform client.

List API Portals`workato_list_api_portals`

List the API portals of the Workato workspace.

List Certificate Bundles`workato_list_certificate_bundles`

List the certificate bundles of the Workato workspace.

Create Certificate Bundle`workato_create_certificate_bundle`

Create a certificate bundle in the Workato workspace.

Update Certificate Bundle`workato_update_certificate_bundle`

Update a Workato certificate bundle.

Delete Certificate Bundle`workato_delete_certificate_bundle`

Delete a Workato certificate bundle.

Download Certificate Bundle`workato_download_certificate_bundle`

Download the PEM file of a Workato certificate bundle.

List Connections`workato_list_connections`

List the connections of the Workato workspace.

Get Connection Picklist`workato_get_connection_picklist`

Get the picklist values of a Workato connection.

Create Connection`workato_create_connection`

Create a connection in the Workato workspace.

Update Connection`workato_update_connection`

Update a connection in the Workato workspace.

Disconnect Connection`workato_disconnect_connection`

Disconnect an active connection in the Workato workspace.

Delete Connection`workato_delete_connection`

Delete a connection from the Workato workspace.

List Connector Metadata`workato_list_connector_metadata`

Get the metadata of named Workato connectors.

List All Connectors`workato_list_all_connectors`

List every connector available in the Workato workspace.

List Outgoing Grants`workato_list_outgoing_grants`

List the cross-workspace grants this Workato workspace shares out.

Get Outgoing Grant`workato_get_outgoing_grant`

Get a cross-workspace grant this Workato workspace shares out.

Create Cross-Workspace Grant`workato_create_cross_workspace_grant`

Share Workato assets with sibling environments in other workspaces.

Update Cross-Workspace Grant`workato_update_cross_workspace_grant`

Update a cross-workspace grant of the Workato workspace.

Revoke Cross-Workspace Grant`workato_revoke_cross_workspace_grant`

Revoke a cross-workspace grant of the Workato workspace.

List Incoming Grants`workato_list_incoming_grants`

List the cross-workspace grants that target this Workato workspace.

Get Incoming Grant`workato_get_incoming_grant`

Get a cross-workspace grant that targets this Workato workspace.

List Source Environments`workato_list_source_environments`

List the Workato environments that can share assets out.

List Target Environments`workato_list_target_environments`

List the Workato environments a source environment can share to.

Generate Schema From JSON`workato_generate_schema_from_json`

Build a Workato schema from a JSON sample.

Generate Schema From CSV`workato_generate_schema_from_csv`

Build a Workato schema from a CSV sample.

Search Custom Connectors`workato_search_custom_connectors`

Search the custom connectors of the Workato workspace by title.

Get Custom Connector Code`workato_get_custom_connector_code`

Get the Ruby code of a Workato custom connector.

Validate Custom Connector Code`workato_validate_custom_connector_code`

Check Workato custom connector code for errors.

Create Custom Connector`workato_create_custom_connector`

Create a custom connector in the Workato workspace.

Update Custom Connector`workato_update_custom_connector`

Update a custom connector of the Workato workspace.

Release Custom Connector`workato_release_custom_connector`

Release the latest version of a Workato custom connector.

Share Custom Connector`workato_share_custom_connector`

Share the released version of a Workato custom connector.

List Data Pipelines`workato_list_data_pipelines`

List the data pipelines of the Workato workspace.

Get Data Pipeline`workato_get_data_pipeline`

Get a single Workato data pipeline.

Create Data Pipeline`workato_create_data_pipeline`

Create a data pipeline in the Workato workspace.

Update Data Pipeline`workato_update_data_pipeline`

Update a Workato data pipeline.

Delete Data Pipeline`workato_delete_data_pipeline`

Delete a data pipeline from the Workato workspace.

Clone Data Pipeline`workato_clone_data_pipeline`

Clone a Workato data pipeline.

Start Data Pipeline`workato_start_data_pipeline`

Start a Workato data pipeline.

Stop Data Pipeline`workato_stop_data_pipeline`

Stop a Workato data pipeline.

List Pipeline Source Providers`workato_list_pipeline_source_providers`

List the applications a Workato data pipeline can read from.

List Pipeline Destination Providers`workato_list_pipeline_destination_providers`

List the destinations a Workato data pipeline can write to.

List Pipeline Source Objects`workato_list_pipeline_source_objects`

List the objects a Workato pipeline source connection offers.

List Pipeline Source Object Fields`workato_list_pipeline_source_object_fields`

List the fields of an object offered by a Workato pipeline source.

Get Pipeline Configuration Schema`workato_get_pipeline_configuration_schema`

Get the configuration fields a Workato data pipeline accepts.

List Pipeline Objects`workato_list_pipeline_objects`

List the objects a Workato data pipeline syncs.

Re-Sync Pipeline Objects`workato_resync_pipeline_objects`

Re-sync objects of a Workato data pipeline.

List Pipeline Runs`workato_list_pipeline_runs`

List the object runs of a Workato data pipeline.

Get Pipeline Run`workato_get_pipeline_run`

Get a single object run of a Workato data pipeline.

List Data Tables`workato_list_data_tables`

List the data tables of the Workato workspace, each with its typed column schema.

Get Data Table`workato_get_data_table`

Get a single Workato data table.

Create Data Table`workato_create_data_table`

Create a data table in the Workato workspace.

Update Data Table`workato_update_data_table`

Update a Workato data table.

Delete Data Table`workato_delete_data_table`

Delete a data table from the Workato workspace.

Truncate Data Table`workato_truncate_data_table`

Delete every record of a Workato data table.

Query Data Table Records`workato_query_data_table_records`

Query the records of a Workato data table.

Create Data Table Record`workato_create_data_table_record`

Create a record in a Workato data table.

Update Data Table Record`workato_update_data_table_record`

Update a record of a Workato data table.

Delete Data Table Record`workato_delete_data_table_record`

Delete a record from a Workato data table.

Generate Record File Upload Link`workato_generate_record_file_upload_link`

Get a link for uploading a file into a Workato data table column.

Download Data Table Record File`workato_download_data_table_record_file`

Download the file held in a Workato data table record.

Create Import File Upload Link`workato_create_import_file_upload_link`

Get a link for uploading a records file into a Workato data table.

Upload Import File`workato_upload_import_file`

Upload a records file to a Workato data table import link.

Describe Import File`workato_describe_import_file`

Describe the file uploaded for a Workato data table import.

Delete Import File`workato_delete_import_file`

Delete the file uploaded for a Workato data table import.

Start Record Import`workato_start_record_import`

Import the uploaded file into a Workato data table.

Dismiss Record Import`workato_dismiss_record_import`

Cancel or dismiss a Workato data table record import.

Build Project`workato_build_project`

Build a Workato project into a deployable build.

Get Project Build`workato_get_project_build`

Get a Workato project build.

Deploy Project Build`workato_deploy_project_build`

Deploy an existing Workato project build to an environment.

Deploy Project`workato_deploy_project`

Build a Workato project and deploy it to an environment.

List Deployments`workato_list_deployments`

List the deployments of the Workato workspace.

Get Deployment`workato_get_deployment`

Get a single Workato deployment.

List Deployment Eligible Reviewers`workato_list_deployment_eligible_reviewers`

List the people who may review a Workato deployment.

Assign Deployment Reviewers`workato_assign_deployment_reviewers`

Assign reviewers to a Workato deployment.

Submit Deployment For Review`workato_submit_deployment_for_review`

Send a Workato deployment to its reviewers.

Approve Deployment`workato_approve_deployment`

Approve a Workato deployment under review.

Reject Deployment`workato_reject_deployment`

Reject a Workato deployment under review.

Reopen Deployment`workato_reopen_deployment`

Put a Workato deployment back into review.

Update Deployment Review Comment`workato_update_deployment_review_comment`

Change the review comment on a Workato deployment.

Deploy Approved Deployment`workato_deploy_approved_deployment`

Run a Workato deployment that reviewers have approved.

Clear Secrets Cache`workato_clear_secrets_cache`

Clear the external secrets manager cache of the Workato environment.

Get Activity Audit Log`workato_get_activity_audit_log`

Read the activity audit log of the Workato environment.

List Tags`workato_list_tags`

List the tags of the Workato workspace.

Create Tag`workato_create_tag`

Create a tag in the Workato workspace.

Update Tag`workato_update_tag`

Update a tag of the Workato workspace.

Delete Tag`workato_delete_tag`

Delete a tag from the Workato workspace.

Manage Tag Assignments`workato_manage_tag_assignments`

Put tags on Workato assets or take them off.

List Event Topics`workato_list_event_topics`

List the event topics of the Workato workspace.

Create Event Topic`workato_create_event_topic`

Create an event topic in the Workato workspace.

Get Event Topic`workato_get_event_topic`

Get a single event topic of the Workato workspace.

Update Event Topic`workato_update_event_topic`

Update an event topic of the Workato workspace.

Purge Event Topic`workato_purge_event_topic`

Erase the message history of a Workato event topic.

Delete Event Topic`workato_delete_event_topic`

Delete an event topic from the Workato workspace.

Consume Event Messages`workato_consume_event_messages`

Read messages from a Workato event topic.

Publish Event Message`workato_publish_event_message`

Publish one message to a Workato event topic.

Publish Event Messages Batch`workato_publish_event_messages_batch`

Publish several messages to a Workato event topic.

List Folders`workato_list_folders`

List the folders of the Workato workspace.

List Projects`workato_list_projects`

List the projects of the Workato workspace.

Get Folder`workato_get_folder`

Get a single folder of the Workato workspace.

Create Folder`workato_create_folder`

Create a folder or project in the Workato workspace.

Update Folder`workato_update_folder`

Rename a folder or move it inside the Workato workspace.

Update Project`workato_update_project`

Change the name or description of a Workato project.

Delete Folder`workato_delete_folder`

Delete a folder from the Workato workspace.

Delete Project`workato_delete_project`

Delete a project from the Workato workspace.

Get Unified Credentials`workato_unified_get_me`

Get the current Workato connection's unified credentials and identity.

List Unified Groups`workato_unified_list_groups`

List unified groups in a Workato workspace.

Get Unified Group`workato_unified_get_group`

Get a unified Workato group by ID.

List Unified Roles`workato_unified_list_roles`

List unified roles in a Workato workspace.

Get Unified Role`workato_unified_get_role`

Get a unified Workato role by ID.

List Unified Users`workato_unified_list_users`

List the workspace collaborators of a Workato workspace as unified users, a page at a time.

Get Unified User`workato_unified_get_user`

Get a unified Workato user by ID.

List Identity Users`workato_list_identity_users`

List the Workato Identity users of the workspace.

Get Identity User`workato_get_identity_user`

Get a single Workato Identity user.

Create Identity Users`workato_create_identity_users`

Create Workato Identity users in the workspace.

Update Identity User`workato_update_identity_user`

Update a Workato Identity user.

Delete Identity User`workato_delete_identity_user`

Delete a Workato Identity user from the workspace.

Add Identity User To Group`workato_add_identity_user_to_group`

Put a Workato Identity user into a group.

Remove Identity User From Group`workato_remove_identity_user_from_group`

Take a Workato Identity user out of a group.

List Identity User Groups`workato_list_identity_user_groups`

List the Workato Identity user groups of the environment.

Get Identity User Group`workato_get_identity_user_group`

Get a single Workato Identity user group.

Create Identity User Group`workato_create_identity_user_group`

Create a Workato Identity user group.

Update Identity User Group`workato_update_identity_user_group`

Rename a Workato Identity user group.

Delete Identity User Group`workato_delete_identity_user_group`

Delete a Workato Identity user group.

Add Identity Users To Group`workato_add_identity_users_to_group`

Put several Workato Identity users into a group.

Remove Identity Users From Group`workato_remove_identity_users_from_group`

Take several Workato Identity users out of a group.

List Identity Group Members`workato_list_identity_group_members`

List the members of a Workato Identity user group.

List App Links`workato_list_app_links`

List the Workato Identity app links of the environment.

Create App Link`workato_create_app_link`

Create a Workato Identity app link.

Delete App Link`workato_delete_app_link`

Delete a Workato Identity app link.

Delete App Links`workato_delete_app_links`

Delete several Workato Identity app links at once.

List Recipe Jobs`workato_list_recipe_jobs`

List the jobs of a Workato recipe.

Get Recipe Job`workato_get_recipe_job`

Get the metadata of a single Workato job.

Resume Job`workato_resume_job`

Resume a waiting Workato job with its resume token.

Repeat Jobs`workato_repeat_jobs`

Repeat finished jobs of a Workato recipe.

Cancel Jobs`workato_cancel_jobs`

Cancel running jobs of a Workato recipe.

List Lookup Tables`workato_list_lookup_tables`

List the lookup tables of the Workato workspace, each with its column schema.

List Lookup Table Rows`workato_list_lookup_table_rows`

List the rows of a Workato lookup table.

Look Up Table Row`workato_lookup_table_row`

Find the first matching row of a Workato lookup table.

Get Lookup Table Row`workato_get_lookup_table_row`

Get a single row of a Workato lookup table.

Add Lookup Table Row`workato_add_lookup_table_row`

Add a row to a Workato lookup table.

Create Lookup Table`workato_create_lookup_table`

Create a lookup table in the Workato workspace.

Delete Lookup Tables In Batch`workato_delete_lookup_tables_in_batch`

Delete several Workato lookup tables at once.

Update Lookup Table Row`workato_update_lookup_table_row`

Update a row of a Workato lookup table.

Delete Lookup Table Row`workato_delete_lookup_table_row`

Delete a row from a Workato lookup table.

List MCP Servers`workato_list_mcp_servers`

List the MCP servers of the Workato workspace.

Create MCP Server`workato_create_mcp_server`

Create an MCP server in the Workato workspace.

Get MCP Server`workato_get_mcp_server`

Get a single Workato MCP server.

Update MCP Server`workato_update_mcp_server`

Update a Workato MCP server.

Delete MCP Server`workato_delete_mcp_server`

Delete a Workato MCP server.

Renew MCP Server Token`workato_renew_mcp_server_token`

Replace the server-wide token of a legacy Workato MCP server.

Create MCP Hashed Token`workato_create_mcp_hashed_token`

Create a named token profile on a Workato MCP server.

Delete MCP Hashed Token`workato_delete_mcp_hashed_token`

Delete a token profile from a Workato MCP server.

Refresh MCP Hashed Token`workato_refresh_mcp_hashed_token`

Replace the value of a Workato MCP token profile.

Assign MCP Server Tools`workato_assign_mcp_server_tools`

Attach tools to a Workato MCP server.

Assign MCP Server User Groups`workato_assign_mcp_server_user_groups`

Give identity provider groups access to a Workato MCP server.

Remove MCP Server User Groups`workato_remove_mcp_server_user_groups`

Take identity provider groups off a Workato MCP server.

Move MCP Server`workato_move_mcp_server`

Move a Workato MCP server into another folder.

Get MCP Server Policy`workato_get_mcp_server_policy`

Get the policy configuration of a Workato MCP server.

Update MCP Server Policy`workato_update_mcp_server_policy`

Update the policy configuration of a Workato MCP server.

List MCP Server Tools`workato_list_mcp_server_tools`

List the tools of a Workato MCP server.

Update MCP Tool Description`workato_update_mcp_tool_description`

Change the description of a Workato MCP tool.

Delete MCP Tool`workato_delete_mcp_tool`

Delete a tool from a Workato MCP server.

List MCP Identity Provider User Groups`workato_list_mcp_idp_user_groups`

List the identity provider groups available to Workato MCP servers.

List MCP Access Assignments`workato_list_mcp_access_assignments`

List the access assignments of a Workato MCP server.

Create MCP Access Assignment`workato_create_mcp_access_assignment`

Give an identity access to tools on a Workato MCP server.

Get MCP Access Assignment`workato_get_mcp_access_assignment`

Get a single access assignment of a Workato MCP server.

Update MCP Access Assignment`workato_update_mcp_access_assignment`

Change the tools an identity may call on a Workato MCP server.

Delete MCP Access Assignment`workato_delete_mcp_access_assignment`

Delete an access assignment from a Workato MCP server.

List Members`workato_list_members`

List the collaborators of the Workato workspace.

Get Member`workato_get_member`

Get one collaborator of the Workato workspace by ID.

Get Member Privileges`workato_get_member_privileges`

Get the environment privileges of a collaborator.

List Member Project Grants`workato_list_member_project_grants`

List the project roles granted directly to a collaborator.

Get Member Projects Privileges`workato_get_member_projects_privileges`

Get the project-level privileges of a collaborator.

Delete Member`workato_delete_member`

Delete a collaborator from the Workato workspace.

Invite Member`workato_invite_member`

Invite a collaborator to the Workato workspace.

Update Member`workato_update_member`

Change the environment roles of a Workato collaborator.

List Custom OAuth Profiles`workato_list_custom_oauth_profiles`

List the custom OAuth profiles of the Workato workspace.

Get Custom OAuth Profile`workato_get_custom_oauth_profile`

Get a single custom OAuth profile of the Workato workspace.

Create Custom OAuth Profile`workato_create_custom_oauth_profile`

Create a custom OAuth profile in the Workato workspace.

Update Custom OAuth Profile`workato_update_custom_oauth_profile`

Update a custom OAuth profile of the Workato workspace.

Delete Custom OAuth Profile`workato_delete_custom_oauth_profile`

Delete a custom OAuth profile from the Workato workspace.

List On-Prem Groups`workato_list_on_prem_groups`

List the on-prem groups of the Workato workspace.

Create On-Prem Group`workato_create_on_prem_group`

Create an on-prem group in the Workato workspace.

Get On-Prem Group`workato_get_on_prem_group`

Get a single Workato on-prem group.

Update On-Prem Group`workato_update_on_prem_group`

Update a Workato on-prem group.

Delete On-Prem Group`workato_delete_on_prem_group`

Delete a Workato on-prem group.

Get On-Prem Group Status`workato_get_on_prem_group_status`

Get the connection status of a Workato on-prem group.

List On-Prem Agents`workato_list_on_prem_agents`

List the on-prem agents of the Workato workspace.

Create On-Prem Agent`workato_create_on_prem_agent`

Create an on-prem agent in a Workato on-prem group.

Get On-Prem Agent`workato_get_on_prem_agent`

Get a single Workato on-prem agent.

Update On-Prem Agent`workato_update_on_prem_agent`

Update a Workato on-prem agent.

Delete On-Prem Agent`workato_delete_on_prem_agent`

Delete a Workato on-prem agent.

Get On-Prem Agent Status`workato_get_on_prem_agent_status`

Get the connection status of a Workato on-prem agent.

Search On-Prem Agents`workato_search_on_prem_agents`

Find Workato on-prem agents by common name.

Get On-Prem Agent Activation Code`workato_get_on_prem_agent_activation_code`

Get the activation code of a Workato on-prem agent.

List Project Grants`workato_list_project_grants`

List the project grants of a Workato project.

Get Project Grant`workato_get_project_grant`

Get a single Workato project grant.

Update Project Grant`workato_update_project_grant`

Change the project role of a Workato project grant.

Delete Project Grant`workato_delete_project_grant`

Delete a project grant from a Workato project.

Add Project Grants`workato_add_project_grants`

Give collaborators or groups project roles on a Workato project.

List Properties`workato_list_properties`

List the Workato configuration settings, held as environment or project properties, whose name starts with a prefix.

Upsert Properties`workato_upsert_properties`

Create or update the Workato configuration settings held as environment or project properties.

List Recipes`workato_list_recipes`

List the recipes of the Workato workspace.

Get Recipe`workato_get_recipe`

Get the details of a Workato recipe.

List Recipe Job Counts`workato_list_recipe_job_counts`

Get the job success and failure counts of Workato recipes.

Create Recipe`workato_create_recipe`

Create a recipe in the Workato workspace.

Update Recipe`workato_update_recipe`

Update a recipe in the Workato workspace.

Copy Recipe`workato_copy_recipe`

Copy a Workato recipe into a folder.

Start Recipe`workato_start_recipe`

Start a Workato recipe.

Stop Recipe`workato_stop_recipe`

Stop a Workato recipe.

Delete Recipe`workato_delete_recipe`

Delete a recipe from the Workato workspace.

Reset Recipe Trigger`workato_reset_recipe_trigger`

Reset the trigger cursor of a Workato recipe.

Update Recipe Connection`workato_update_recipe_connection`

Point a Workato recipe at a different connection.

Activate Recipe Polling Trigger`workato_activate_recipe_polling_trigger`

Run the polling trigger of a Workato recipe at once.

Force Run Recipe`workato_force_run_recipe`

Run a scheduled Workato recipe once, on demand.

Get Recipe Versions`workato_get_recipe_versions`

List the versions of a Workato recipe.

Get Specific Recipe Version`workato_get_specific_recipe_version`

Get a single version of a Workato recipe.

Update Recipe Version Comment`workato_update_recipe_version_comment`

Change the comment on a version of a Workato recipe.

Get Recipe Health`workato_get_recipe_health`

Get the most recent Performance Copilot report of a Workato recipe.

Start Recipe Health Analysis`workato_start_recipe_health_analysis`

Queue a Performance Copilot scan of a Workato recipe.

List Resources`workato_list_resources`

List the resource files in a folder of a Workato project.

Upload Resource`workato_upload_resource`

Upload a resource file into a folder of a Workato project.

Download Resource`workato_download_resource`

Download a resource file from a Workato project.

Delete Resource`workato_delete_resource`

Delete a resource file from a Workato project.

View Folder Assets`workato_view_folder_assets`

List the assets of a Workato folder for an export manifest.

Create Export Manifest`workato_create_export_manifest`

Create a Workato export manifest.

Update Export Manifest`workato_update_export_manifest`

Update a Workato export manifest.

View Export Manifest`workato_view_export_manifest`

Get a Workato export manifest.

Delete Export Manifest`workato_delete_export_manifest`

Delete a Workato export manifest.

Export Package`workato_export_package`

Export a Workato package from an export manifest.

Import Package`workato_import_package`

Import a Workato package zip into a folder.

Get Package`workato_get_package`

Get the state of a Workato package export or import.

Download Package`workato_download_package`

Download a Workato package zip.

Migrate System Roles`workato_migrate_system_roles`

Convert the legacy Workato system roles into environment and project roles.

Migrate Custom Role`workato_migrate_custom_role`

Convert a legacy Workato custom role into an environment and project role.

List Environment Roles`workato_list_environment_roles`

List the environment roles of the Workato workspace.

Get Environment Role`workato_get_environment_role`

Get one environment role with its privileges.

List Legacy Roles`workato_list_legacy_roles`

List the custom roles of the legacy Workato permissions model.

List Project Roles`workato_list_project_roles`

List the project roles of the Workato workspace.

Get Project Role`workato_get_project_role`

Get one project role with its privileges.

Create Environment Role`workato_create_environment_role`

Create an environment role in the Workato workspace.

Update Environment Role`workato_update_environment_role`

Update an environment role of the Workato workspace.

Delete Environment Role`workato_delete_environment_role`

Delete an environment role from the Workato workspace.

Create Project Role`workato_create_project_role`

Create a project role in the Workato workspace.

Update Project Role`workato_update_project_role`

Update a project role of the Workato workspace.

Delete Project Role`workato_delete_project_role`

Delete a project role from the Workato workspace.

Update Legacy Role`workato_update_legacy_role`

Change the projects a Workato legacy custom role reaches.

Copy Legacy Role`workato_copy_legacy_role`

Copy a Workato legacy custom role under a new name.

Run Test Cases`workato_run_test_cases`

Run Workato Test Automation test cases.

Get Test Case Run Request`workato_get_test_case_run_request`

Get the state of a Workato test case run.

Get Recipe Test Cases`workato_get_recipe_test_cases`

List the Test Automation test cases of a Workato recipe.

List User Groups`workato_list_user_groups`

List the collaborator groups of the Workato workspace.

Get User Group`workato_get_user_group`

Get one collaborator group by ID.

List User Group Members`workato_list_user_group_members`

List the collaborators and pending invitations in a group.

List User Group Project Grants`workato_list_user_group_project_grants`

List the project roles granted to a collaborator group.

Add User Group Members`workato_add_user_group_members`

Add collaborators to a collaborator group.

Create User Group`workato_create_user_group`

Create a collaborator group in the Workato workspace.

Update User Group`workato_update_user_group`

Update a collaborator group of the Workato workspace.

Delete User Group`workato_delete_user_group`

Delete a collaborator group from the Workato workspace.

Remove User Group Members`workato_remove_user_group_members`

Remove collaborators from a Workato collaborator group.

Get Workspace Details`workato_get_workspace_details`

Get the details of the Workato workspace behind the token.

List XChange Packages`workato_list_xchange_packages`

List the XChange packages of the Workato workspace.

List XChange Package Versions`workato_list_xchange_package_versions`

List the versions of a Workato XChange package.

Get XChange Package Version`workato_get_xchange_version`

Get a single version of a Workato XChange package.

Update XChange Version Metadata`workato_update_xchange_version`

Update the metadata of a Workato XChange package version.

Import XChange Package`workato_import_xchange_package`

Create a Workato XChange package from a zip file.

Import XChange Package Version`workato_import_xchange_version`

Add a version to a Workato XChange package from a zip file.

Get XChange Version Draft Status`workato_get_xchange_version_draft`

Get the state of a Workato XChange version being built.

Get XChange Version Download URL`workato_get_xchange_version_download_url`

Get the download link for a Workato XChange package version.

Approve XChange Version`workato_approve_xchange_version`

Approve a Workato XChange package version.

Reject XChange Version`workato_reject_xchange_version`

Reject a Workato XChange package version.

Reset XChange Version Review`workato_reset_xchange_version_review`

Reset the review of a Workato XChange package version.

Update XChange Review Comment`workato_update_xchange_review_comment`

Change the comments on a Workato XChange review.

Publish XChange Version`workato_publish_xchange_version`

Publish a Workato XChange package version to the private library.

Unpublish XChange Version`workato_unpublish_xchange_version`

Take a Workato XChange version out of the private library.

List XChange Package Consumers`workato_list_xchange_package_consumers`

List the workspaces that may install a Workato XChange package.

Create XChange Distribution Batch`workato_create_xchange_distribution`

Push a Workato XChange version out to environments.

List XChange Distribution Batches`workato_list_xchange_distributions`

List the distribution batches of Workato XChange.

Get XChange Distribution Batch`workato_get_xchange_distribution`

Get a single Workato XChange distribution batch.

Retry Failed XChange Distributions`workato_retry_xchange_distribution`

Retry the failed targets of a Workato XChange distribution batch.

List XChange Sharing Links`workato_list_xchange_sharing_links`

List the sharing links of a Workato XChange package.

Create XChange Sharing Links`workato_create_xchange_sharing_links`

Create sharing links for a Workato XChange package.

Activate XChange Sharing Link`workato_activate_xchange_sharing_link`

Activate a sharing link of a Workato XChange package.

Deactivate XChange Sharing Link`workato_deactivate_xchange_sharing_link`

Deactivate a sharing link of a Workato XChange package.

Delete XChange Sharing Link`workato_delete_xchange_sharing_link`

Delete a sharing link of a Workato XChange package.

Set XChange Shared Link Version`workato_set_xchange_shared_link_version`

Choose which version the sharing links of a Workato XChange package serve.

Clear XChange Shared Link Version`workato_clear_xchange_shared_link_version`

Stop the sharing links of a Workato XChange package serving a version.

Get XChange Package Statistics`workato_get_xchange_package_stats`

Get the installation statistics of a Workato XChange package.

Get XChange Package Installations`workato_get_xchange_package_installations`

List the workspaces that installed a Workato XChange package.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.