Automations

Run an Automation now

Changed on

Den schedules Automations and keeps durable run history. A Desktop Automation runs on any of the owner's connected desktops (one pinned to a workspace, on a desktop that has it); a Cloud Automation runs in OpenWork Cloud. If no desktop runner is connected when a desktop occurrence is due, that occurrence is recorded as missed. Creation makes an Automation active immediately and uses the owner's current OpenWork Connect integrations. Deactivation stops future runs but does not cancel a run already in progress. Send executionTarget "cloud" to run a Desktop Automation once in OpenWork Cloud without changing it. Agents cannot run a Cloud Automation on a desktop.

post/v1/automations/{id}/run

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/automations/{id}/run
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

Request body

executionTarget'desktop' | 'cloud'

Run this one occurrence on this target instead of the Automation's own.

Response

Run queued.

Changes

  • d78112687ff5Revision changes
    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API