The Home app will be discontinued at the end of 2025 and will no longer be available from January 2026. With the discontinuation, support for the corresponding API will also end. Features that were previously available via dedicated routes will then no longer be displayed. Please switch to the Dashboard app API. This change affects all applications that currently use the Home app API.
To ensure a smooth transition, the modern Dashboard Widget API v2.0 is already available as a fully-fledged alternative. For more information, see Dashboard API documentation. Although Dashboard Widget API v1.0 will continue to be supported for the time being, it should no longer be used.
The new Dashboard Widget API v2.0
The Dashboard Widget API v2.0 combines all previous functionalities in a modern, uniform interface. The API was developed to make the management of dashboard widgets more efficient and flexible.
Registration of widgets in the tenant
Unlike the old API, the Dashboard app no longer retrieves the widgets of the respective apps; instead, the apps actively register their widgets with the Dashboard app.
You can use the Cloud Center's app lifecycle events as triggers for registration:
- subscribe: For the initial registration of a widget in a new tenant.
- unsubscribe or purge: For removing a widget.
To update existing widgets, you can use calls to your app's root resource as triggers, for example.
Best practice: Only trigger the update if something has actually changed in the widget configuration. This approach avoids unnecessary API calls and improves the performance of your application.
Easy migration: The converter
d.velop has developed a convenient converter tool for migrating from Home API or Dashboard Widget API v1.0 to the new version 2.0. This way, migration is simple, fast, and straightforward.
Access
The converter can be accessed at the route /dash/converter.
You need administrator permissions.
Procedure
Enter the app name.
The converter automatically retrieves all existing registrations:
Home app registrations
Dashboard v1.0 registrations
All available language versions are taken into account.
The converter generates an equivalent JSON object which you can use directly for registration via the Dashboard Widget API v2.0.
You will receive the DELETE call to delete the old Dashboard Widget API v1.0 registration.
If you provide the ID of the new registration in the DELETE call, the old widget will automatically be replaced by the new widget on all dashboards. This avoids interruptions for your users.
Recommended action
d.velop recommends implementing the migration as soon as possible in order to guarantee time for testing and any necessary adjustments. The new Dashboard Widget API v2.0 and the converter are now available.
If you have any questions or encounter any problems during the migration, please contact d.velop support.