← All release notes

October 23, 2023 · Control Room

Introducing the new Control Room API and Worker Events

We are excited to announce two new major features that will help you to better integrate with Robocorp Control Room and to give better visibility to self-hosted Workers.

New API based on the OpenAPI v3 specification

Control Room API doc page for the 'list work items of a process run' endpoint with a curl example

The new unified Control Room API consolidates the old Process, Robot, Assistant and Worker APIs under one consistent set of endpoints. Naming conventions now also reflect the current terminology used across Robocorp. The API is specified using OpenAPI v3, which makes building integrations a breeze. For example, it enables you to take advantage of all the tooling built on the top of the OpenAPI ecosystem, e.g., generating custom SDKs directly from the specification file.

The old APIs are now deprecated but will be available until the 15th of January 2025. No immediate action is required. We will be sending reminders to users of the old APIs until the discontinuation.

Authentication and authorization mechanisms will stay the same, and any existing API keys will work with the new API. We highly recommend building all new implementations on the top of the new API, and to start converting old implementations to the new specification. No new features will be added to the old API endpoints. If you need any guidance with migrating to the new API, please contact your technical account manager.

Finally, the new API is hosted under the same domain name used to access Control Room. The API helper guides you to use the appropriate domain name. This reduces the number of domains to be allow-listed and thus simplifies the network configuration requirements.

For more details about the new API please see the updated API documentation.

Worker Event Log and Notifications

Worker email notification list showing team members' Error and Offline alert checkboxes

The new Worker event log shows events happening in the self-hosted Workers, giving visibility to the status. It helps with troubleshooting any issues related to the configuration or the host machine.

We have also added a new notification feature, which enables you to receive e-mail notifications about the selected events you want. This enables you to stay on top of operations and take action if required.

Features

  • New Control Room API
  • Worker Event Log
  • Worker Notifications

Purple circular icon of the smiling Robocorp monkey mascot