Robocorp Control Room Integration

Robocorp is the leading Python-based Robotic Process Automation (RPA) platform. Use PixieBrix with Robocorp to enable seamless attended automation:

  • Triggering processes directly from the browser

  • Creating/updating work items

  • Fetching processes and statuses

Creating a Robocorp Workspace API Key

From the Robocorp documentation:

The preferred way to control your processes and robots via API calls is now via the Workspace-scoped API.

Follow Robocorp’s documentation to create a Workspace-scope API key

Locating your Workspace ID

Your Workspace ID is a UUID, for example 35550033-33ca-4268-bd48-15a2ded51282.

Find your Workspace ID on the Configuration > Settings screen for your Workspace:

Locating your Process ID

Locate the ID of your Process by opening your process in the Control Room and copying the Process ID from the URL Bar.

Alternatively, you can use the /process-v1/workspaces/{workspaceId}/processes Control Room API to find the Process IDs of your Robocorp processes

Configuring a Robocorp Integration in PixieBrix

To set up a cloud integration that your team can access, head to the Admin Console. (If you'd rather set up something locally, use the Extension Console. Learn more about Configuring Integrations.)

From the Integrations section in the Admin or Extension Console, click the + Add Integration button in the top right corner.

Search for and select the Robocorp integration.

In the configuration modal that appears, provide the following:

  • Base URL: defaults to https://api.eu1.robocorp.com. You generally should not need to change the Base URL setting

  • Workspace API Key: the Workspace API key. Must correspond to the Workspace provided when making HTTP requests

Calling the Robocorp Process and Robot APIs

πŸ“š The Robocorp API documentation is available in the Robocorp Documentation Portal

πŸ’œ New to creating mods in PixieBrix? Learn about the Page Editor.

Starting Processes with the Start Robocorp Process Brick

  1. Add the Start Robocorp Process brick to your mod

  2. Provide the following configuration:

    1. Select the Control Room Integration Configuration. The API key must correspond to the Workspace ID you provide

    2. Provide the Workspace ID

    3. Provide the Process ID

    4. Provide Work Item Data (Optional)

Calling any Control Room API method with the HTTP Request Brick

  1. Add an HTTP Request brick to your mod

  2. Provide the following configuration:

    1. URL: the relative URL including your Workspace ID

    2. Integration Configuration: a Robocorp Integration Configuration. The API key must correspond to the Workspace ID you provide

    3. Method: GET/POST/PUT: see the Robocorp API documentation

Troubleshooting

I get a [apiKey]' not a valid key=value pair (missing equal-sign) in Authorization header error when making an API call

This error can occur if the HTTP Method is not correct for the request. Double-check you are using the correct HTTP Method for the request, e.g. GET vs. POST vs. PUT

Click Save, and your integration will be ready for use in any Robocorp mods.

Last updated