Changelog

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.

New fields have been added to the following endpoints:

• Get Job (Developer API / Embedded API) API endpoint have new error fields for additional visibility when troubleshooting jobs - error count, step, app, action, and retry count
• Create Recipe (Developer API / Embedded API) and Update Recipe (Developer API / Embedded API) API endpoints have a new field to update the recipe description

The new auto_generate_assets property can be used to automatically generate the assets list of the specified folder when creating (Developer API / Embedded API) or updating (Developer API / Embedded API) a manifest. This new property eliminates the need to manually list each asset to be included in the created manifest. The auto_generate_assets property can be used in conjunction with the following new properties:

• include_test_cases: include test cases if specified, false by default
• include_data: include data if specified, false by default
• auto_run: start package generation automatically, false by default

Beginning today, new Embedded Partners will have the ability to provision Environments for their customers. The Environments feature allows built-in access to Development, Test, and Production deployment environments, giving way for a well-structured change management process within the automation framework.

For existing Embedded Partners, this functionality will be rolled out in the next 2-4 weeks upon request, or to all partners in general availability after that. You can read more about Embedded Environments on our Product Hub.

Embedded API for Jobs: You can now view recipe job information in customer workspaces. Two new endpoints are now available for a specific recipe in a customer's account - one to retrieve a list of that recipe's aggregated job information and one to retrieve one single job's metadata information by its job handle.

Delete Projects: Delete projects from your workspace after deploying to your customer accounts. This action deletes a project and all of its contents (folders, recipes, connections, and workflow apps assets).

Delete Folders: Delete folders from customer workspaces. This action deletes a folder and all of its contents (recipes and connections).

Copy a Recipe: You can now copy an existing recipe in Workato based on its recipe ID.

Starting today, we're allowing our users to opt in remove access to their collaborator's personal Workato workspaces so that they'll only be able to build inside of pre-approved  workspace. For companies with strict security and compliance protocols, we highly recommend opting in to this security update as this leaves no action taken by your collaborators unlogged and unauditable. This change is compatible with both direct and embed customer accounts.

For maximum activity logging, we recommend setting up audit log streaming too!