Changelog

Embedded Partners can better track and manage complex automation workflows across customer workspaces with improved API job tracking and filtering capabilities.

What's new:

• List Jobs: New response fields for parent-child job tracking: calling_job_id, calling_recipe_id, root_job_id, root_recipe_id, status, and recipe_id
• List Recipes: New query parameters with_subfolders for advanced filtering, plus new response fields project_id, count, page, and per_page for pagination support
• List Folders: New query parameters with_nested_folder and updated_after for advanced filtering, plus new response fields count, page, and per_page for pagination support
• List Projects: New query parameter updated_after for filtering recent changes, plus new response fieldscount, page, and per_page for pagination support
• List Connections: New query parameter updated_after for filtering recent changes

These updates apply to both Embedded and Developer APIs.

We’ve implemented new rate limits across all Embedded API endpoints to ensure continued performance and stability of the platform.

See the documentation for each endpoint’s specific limits to optimize your API usage.

Applies to all Workato Embedded Partners using Embedded APIs.

Embedded Partners can now hide, lock, and pre-fill fields within Workato’s Connection Widget to simplify authentication and eliminate friction for end customers.

Partners can remove optional fields that previously caused confusion, pre-populate standard values, or lock critical settings to prevent errors. Plus, new schema APIs make it easier to identify which fields can be customized for each connector.

Learn more: Get Connection Endpoint, Get Connector Endpoint, and Customize the Connection Widget 

Embedded Partners can now manage Developer API clients in customer workspaces via Embedded APIs, streamlining setup and improving security.

What's new:

• API client provisioning: Create, update, and delete API clients with simple requests—no manual setup needed.
• Token management: Regenerate tokens, update roles, or remove access across multiple customers programmatically.
• Role management: List and copy API client roles to standardize permissions.

Note: Available to Embed Customers with API management enabled. Contact support for details.

Dynamic Field Mapping is now available for Embed partners, enabling seamless mapping between third-party systems outside the recipe builder.

• Allows end customers to map standard or custom fields from source steps to a destination step without modifying the core recipe logic.
• Supports both API-based implementation and iFrame widget embedding.
• Ideal for partners looking to provide flexible integrations directly within their own platforms.
• Once enabled for an Embed partner, the feature is available to all their end customers.
  

Learn more in the Dynamic Field Mapping documentation and demo video.

We're excited to announce two updates to the Embedded Platform.

Admin Console Reporting:

The Admin Console now reports all active connections across all end-customer environments.

When Environments are enabled, connection counts are now aggregated across all environments, ensuring consistent reporting with cases where Environments are not enabled.

This enhancement provides Embed Partners with improved visibility into their customers' usage.

For more details, see the Admin Console Reporting Documentation.

Activity Audit Logs:

Activity audit logs now capture and audit changes made to an end customer through an embed API directly within that end customer's workspace.

This update improves visibility and traceability of API-driven changes within the appropriate customer environment.

For more details, see the Activity Audit Log Documentation.

We are excited to introduce a new parameter, shell_connection, which allows users to specify the nature of a connection when established via API. 

• shell_connection:false  (Default behavior)
  • Credentials are passed in via API, and the connection is tested and established accordingly.
  • Note: If the parameter is not specified, the API will behave as though shell_connection:false.
• shell_connection:true
  • Credentials are passed in via API, but the connection is not tested or established. Additional action is required to fully authenticate the connection.

Specifying shell_connection:true Workato will not automatically attempt a test authentication and, thus, no “Connection Lost” banner will display within the connection page.

This new parameter will provide greater flexibility in how connections are managed and established through our API, enhancing user control over connection authentication processes. Learn more here.

Workato has introduced the Recipe Widget, a new iframe widget for the Embedded Platform. This feature allows partners to embed a streamlined view of an individual recipe page into their own product via an iframe, enhancing the seamless integration experience:

• Focused Embedding: Displays only the recipe canvas, jobs table, and version history, removing unnecessary UI elements.
• Enhanced Customization: Partners maintain full control over navigation and user experience.
• Optimized for Embed Partners: Designed based on high demand, including from Freshworks and other leading partners.

We’re excited to announce some new additions and enhancements to our Embedded API endpoints!

New endpoints:

• Get usage (v2): Retrieves usage metrics for specified customer workspaces within a defined timeframe.
• List On-prem Groups: Retrieves a list of all On-prem Groups in a customer workspace.
• List On-prem Agents: Retrieves a list of all On-prem Agents in a customer workspace.
• Get details about an On-prem Agent: Retrieves detailed information about an On-prem Agent within a customer workspace using its unique ID.
• Get connections based usage: Retrieves connection-based usage metrics for specified customer workspaces and can be aggregated across customer workspaces.

Updated endpoints:

• Add member to customer workspace: Add a member to the specified Embedded customer workspace.
• Create customer: Create a new Embedded customer.

When interacting with the Embedded API connection methods, there are now two values returned to help understand when and how a connection was lost: connection_lost_at and cconnection_lost_reason.