New Workflows namespace APIs for automation management
The Workflows namespace now includes APIs for managing automations and their integrations. These new namespaced APIs replace the legacy v1 equivalents and provide standardized interfaces aligned with Qlik’s API design principles.
What’s available
The Workflows namespace includes three related APIs:
- Automations API (
/workflows/automations): Create, read, update, and manage automation workflows in the Workflows namespace. - Automation Connections API (
/workflows/automation-connections): Manage connection credentials and configurations. - Automation Connectors API (
/workflows/automation-connectors): Access available connector definitions and capabilities.
Why migrate
The new Workflows namespace APIs offer:
- Consistency: Standardized request/response formats and query parameters aligned with Qlik API design principles.
- Clarity: APIs grouped by business context, making it easier to find and understand related resources.
- Future-proof: Prepared for versioning support, enabling non-breaking improvements.
- Simplified paths: Removal of
v1from the path for cleaner, more intuitive API routes.
Migration path
The legacy v1 APIs (/v1/automations, /v1/automation-connections, and
/v1/automation-connectors) remain fully supported and are not yet deprecated.
At the point of deprecation there will be a 12-month minimum
deprecation window. Check this changelog for deprecation notices with clear
timelines.
To start migrating:
- Review the Automations API, Automation Connections API, and Automation Connectors API documentation.
- Update your API calls to use the new
/workflows/*paths. - Test your integrations in a non-production environment first.
- Deploy updates during your normal release schedule.
For details about API namespaces, timing, and the complete list of available namespaced APIs, see the API namespaces overview.