Running a process with API Keys

You can start a process from outside PROCESIO by calling the PROCESIO API with an API key. This page shows how, using Postman as the example.

What you need

• An API key, with its key handle and key value. Create it on the API Key page of the workspace that holds the process, and copy the value right away: it is shown only once. See API Keys.
• The process ID. Open the process, then Edit process properties, and copy the ID (see Process settings). You can also copy it from the process list.
• The workspace ID, for a process in a shared workspace. It is shown under the title of the workspace's Dashboard, as Workspace ID, with a copy icon. You don't need it for a process in your personal workspace.

Send the request

1. Create a POST request to https://webapi.procesio.app/api/Projects/<process ID>/run.

2. Under Headers, add:

   Header	Value
   key	The key handle.
   value	The key value.
   workspaceId	The workspace ID. Leave it out for a key you created in your personal workspace.

   If you also send an x-version header, its value must be 1.19.

3. Under Body, choose raw and JSON, and send the values of the process's Input variables in payload.

{
  "payload": {
    "inputVariableExample": 2.03
  },
  "connectionId": null
}

4. Click Send. The process starts, and the run appears on the process's Instances page. See Process runs and history.

For all the endpoints, see PROCESIO API Documentation and the API reference (Swagger).