Changelog

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
• Get usage (v2): Retrieves usage metrics for specified customer workspaces within a defined time frame, including task usage, recipe counts, and counts of successful and failed jobs.

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!

Our Embedded Private Community feature is now available in all of Workato's data centers, including US, EU, JP, SG, and AU data centers. With Private Community, users can choose the apps and recipes customers see as they browse for community recipes.

Embedded Admins can now grant varying access rights to different features of the Embedded Admin Console, including granular permissions to view, manage or delete Customer Accounts, Customer Managers, and Shared Connectors, as well as view or manage permissions to Usage Metrics and other settings. These permissions can be found when creating a custom Collaborator Role within the Admin workspace.

Our commitment to security is unwavering. In this exciting release, we're introducing an API endpoint that allows customers to seamlessly rotate public keys used for JWT tokens.

Key Features & Changes:

• Public Key Rotation via API: Enhance your security posture by rotating your RSA Public Key directly through our new API, without the need to communicate them in plain text.
• Retrieve Your Workato Embedded Vendor ID: In the API response, you can easily retrieve the vendor_id, which provides the essential Workato Embedded Vendor ID for JWT.
• Updated Terminology: We're continuously improving clarity! The term previously known as the OEM Vendor API Key has now been renamed to "Workato Embedded Vendor ID" in our documentation.