ESescape
Workflows

Create workflows.

Create a workflow.

post/workflows

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Request body

organizationIdstring uuid required

The organization ID to create the workflow for

namestring required

The name of the workflow

trigger'ASSET_FOUND' | 'ASSET_UPDATED' | 'INTEGRATION_FAILED' | 'ISSUE_UPDATED' | 'LOCATION_DOWN' | 'MANUAL' | 'NEW_ISSUE' | 'SCAN_COMPLETED' | 'SCAN_FAILED' | 'SCAN_STARTED' required
throttleMsnumber nullable required

The throttle in milliseconds for the workflow.

viewIdstring uuid nullable

Saved view to apply as the workflow filter.

projectIdsstring[]

Optional list of project IDs to create the integration for

Example request

{
  "projectIds": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001"
  ]
}

Response

OK

idstring uuid

The workflow ID.

namestring

The name of the workflow.

descriptionstring nullable required

The description of the workflow. Null when the workflow has no description.

trigger'ASSET_FOUND' | 'ASSET_UPDATED' | 'INTEGRATION_FAILED' | 'ISSUE_UPDATED' | 'LOCATION_DOWN' | 'MANUAL' | 'NEW_ISSUE' | 'SCAN_COMPLETED' | 'SCAN_FAILED' | 'SCAN_STARTED' required
pausedboolean required

Whether the workflow is paused.

throttleMsnumber nullable required

The throttle in milliseconds for the workflow.

createdAtstring date-time required

The date and time the workflow was created.

updatedAtstring date-time required

The date and time the workflow was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.