Skip to main content

Workflows

What you can do with Workflow#

Workflow Properties#

title
REQUIRED

Type: string|null

type
REQUIRED

Type: string

workspace
REQUIRED

Type: string (format: iri-reference)

credentials

Type: string|null (format: iri-reference)

notificationEmails

Type: array

enabled
REQUIRED

Type: boolean

lastRunDate

Type: string|null (format: date-time)

period
REQUIRED

Type: string

applies only to out

integration

Type: object|null

Example:
"integration": {
  "title": "string|null",
  "type": "string",
  "workspace": "string",
  "credentials": "string|null",
  "notificationEmails": "array",
  "enabled": "boolean",
  "lastRunDate": "string|null",
  "period": "string",
  "integration": "object|null",
  "firstTimeSetupPassed": "boolean",
  "tags": "array",
  "id": "string",
  "integrationType": "string|null",
  "passive": "boolean",
  "remote": "boolean",
  "firstTimeSetupRequired": "boolean",
  "runInProgress": "boolean"
}
  • title:
  • type:
  • workspace:
  • credentials:
  • notificationEmails:
  • enabled:
  • lastRunDate:
  • period:

    applies only to out

  • integration:
  • firstTimeSetupPassed:
  • tags:
  • id:
  • integrationType:
  • passive:
  • remote:
  • firstTimeSetupRequired:
  • runInProgress:

firstTimeSetupPassed

Type: boolean

tags

Type: array

id
READ-ONLY

Type: string (format: uuid)

integrationType
READ-ONLY

Type: string|null

passive
READ-ONLY

Type: boolean

remote
READ-ONLY

Type: boolean

firstTimeSetupRequired
READ-ONLY

Type: boolean

runInProgress
READ-ONLY

Type: boolean

Endpoints#

GET
/workflows
Retrieves the collection of Workflow resources.
Query Parameters
NameInIs RequiredTypeDescription
typequeryNostring
type[]queryNoarray
Array of Strings.
periodqueryNostring
period[]queryNoarray
Array of Strings.
titlequeryNostring
order[createdAt]queryNostring
Allowed values: asc|desc
tagqueryNostring
exists[integration]queryNoboolean
firstTimeSetupPassedqueryNoboolean
first_time_setup_requiredqueryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workflows/{id}
Retrieves a Workflow resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
GET
/workflows/{id}/runs
Retrieves the collection of WorkflowRun resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
statusqueryNostring
status[]queryNoarray
Array of Strings.
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/workflows
Retrieves the collection of Workflow resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
typequeryNostring
type[]queryNoarray
Array of Strings.
periodqueryNostring
period[]queryNoarray
Array of Strings.
titlequeryNostring
order[createdAt]queryNostring
Allowed values: asc|desc
tagqueryNostring
exists[integration]queryNoboolean
firstTimeSetupPassedqueryNoboolean
first_time_setup_requiredqueryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/workflows/{workflows}/runs
Retrieves the collection of WorkflowRun resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workflowspathYesstring
statusqueryNostring
status[]queryNoarray
Array of Strings.
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/workflows
Retrieves the collection of Workflow resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
typequeryNostring
type[]queryNoarray
Array of Strings.
periodqueryNostring
period[]queryNoarray
Array of Strings.
titlequeryNostring
order[createdAt]queryNostring
Allowed values: asc|desc
tagqueryNostring
exists[integration]queryNoboolean
firstTimeSetupPassedqueryNoboolean
first_time_setup_requiredqueryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/workflows/{workflows}/runs
Retrieves the collection of WorkflowRun resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
workflowspathYesstring
statusqueryNostring
status[]queryNoarray
Array of Strings.
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
POST
/workflows
Creates a Workflow resource.
Request Body Parameters

title
REQUIRED

Type: string|null

type
REQUIRED

Type: string

workspace
REQUIRED

Type: string (format: iri-reference)

credentials

Type: object|null

Example:
"credentials": {
  "type": "string",
  "team": "string|null"
}
  • type:
  • team:

notificationEmails

Type: array

enabled
REQUIRED

Type: boolean

period
REQUIRED

Type: string

applies only to out

integration

Type: object|null

Example:
"integration": {
  "title": "string|null",
  "type": "string",
  "workspace": "string",
  "credentials": {
    "type": "string",
    "team": "string|null"
  },
  "notificationEmails": "array",
  "enabled": "boolean",
  "period": "string",
  "integration": "object|null",
  "firstTimeSetupPassed": "boolean"
}
  • title:
  • type:
  • workspace:
  • credentials:
  • notificationEmails:
  • enabled:
  • period:

    applies only to out

  • integration:
  • firstTimeSetupPassed:

firstTimeSetupPassed

Type: boolean

POST
/workflows/execute
Creates a Workflow resource.
Request Body Parameters
No properties
POST
/workflows/submit-suggestion
Creates a Workflow resource.
Request Body Parameters

comment

Type: string|null

PUT
/workflows/{id}
Replaces the Workflow resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
Request Body Parameters

title
REQUIRED

Type: string|null

type
REQUIRED

Type: string

workspace
REQUIRED

Type: string (format: iri-reference)

credentials

Type: string|null (format: iri-reference)

notificationEmails

Type: array

enabled
REQUIRED

Type: boolean

period
REQUIRED

Type: string

applies only to out

integration

Type: object|null

Example:
"integration": {
  "title": "string|null",
  "type": "string",
  "workspace": "string",
  "credentials": "string|null",
  "notificationEmails": "array",
  "enabled": "boolean",
  "period": "string",
  "integration": "object|null",
  "firstTimeSetupPassed": "boolean"
}
  • title:
  • type:
  • workspace:
  • credentials:
  • notificationEmails:
  • enabled:
  • period:

    applies only to out

  • integration:
  • firstTimeSetupPassed:

firstTimeSetupPassed

Type: boolean

DELETE
/workflows/{id}
Removes the Workflow resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring