Workflows Route
On this page
- Update, replace, or create new, Workflow for Canvas
- Update, replace, or create new, Workflow
- Convert workflow to compose model for UI Designer and detailed Activity screens.
- Create a new workflow
- Delete a workflow
- Duplicates the workflow.
- Export the Workflow as JSON.
- Retrieve the parameters.
- Retrieve the changlog
- Retrieve a Workflow
- Search for Workflows
- Submit a Workflow to be run. Will queue the WorkflowRun ready for execution.
Workflows Route
| Name | Method | Endpoint |
|---|---|---|
| Update, replace, or create new, Workflow for Canvas | PUT | /api/v2/team/{team}/workflow/{workflow}/compose |
| Update, replace, or create new, Workflow | PUT | /api/v2/team/{team}/workflow |
| Convert workflow to compose model for UI Designer and detailed Activity screens. | GET | /api/v2/team/{team}/workflow/{workflow}/compose |
| Create a new workflow | POST | /api/v2/team/{team}/workflow |
| Delete a workflow | DELETE | /api/v2/team/{team}/workflow/{workflow} |
| Duplicates the workflow. | POST | /api/v2/team/{team}/workflow/{workflow}/duplicate |
| Export the Workflow as JSON. | GET | /api/v2/team/{team}/workflow/{workflow}/export |
| Retrieve the parameters. | GET | /api/v2/team/{team}/workflow/{workflow}/available-parameters |
| Retrieve the changlog | GET | /api/v2/team/{team}/workflow/{workflow}/changelog |
| Retrieve a Workflow | GET | /api/v2/team/{team}/workflow/{workflow} |
| Search for Workflows | GET | /api/v2/team/{team}/workflow/query |
| Submit a Workflow to be run. Will queue the WorkflowRun ready for execution. | POST | /api/v2/team/{team}/workflow/{workflow}/submit |
Update, replace, or create new, Workflow for Canvas
PUT /api/v2/team/{team}/workflow/{workflow}/compose?replace=true
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| replace | Boolean | false | Replace existing version | Defaults to false. | true |
Request Body
| Schema | Required |
|---|---|
| WorkflowCanvas | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
application/json - Accept:
*/*
Response
Update, replace, or create new, Workflow
PUT /api/v2/team/{team}/workflow?replace=true
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| replace | Boolean | false | Replace existing version | Defaults to false. | true |
Request Body
| Schema | Required |
|---|---|
| Workflow | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
application/json - Accept:
*/*
Response
Convert workflow to compose model for UI Designer and detailed Activity screens.
GET /api/v2/team/{team}/workflow/{workflow}/compose?version=56
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
| version | Integer | false | Workflow Version | Defaults to null. | 56 |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Create a new workflow
POST /api/v2/team/{team}/workflow
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
Request Body
| Schema | Required |
|---|---|
| Workflow | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
application/json - Accept:
*/*
Response
Delete a workflow
DELETE /api/v2/team/{team}/workflow/{workflow}
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
Not defined
Response
null (empty response body)
Duplicates the workflow.
POST /api/v2/team/{team}/workflow/{workflow}/duplicate
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Export the Workflow as JSON.
GET /api/v2/team/{team}/workflow/{workflow}/export
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
application/json
Response
File
Retrieve the parameters.
GET /api/v2/team/{team}/workflow/{workflow}/available-parameters
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
List
Retrieve the changlog
GET /api/v2/team/{team}/workflow/{workflow}/changelog
Retrieves each versions changelog and returns them all as a list.
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Retrieve a Workflow
GET /api/v2/team/{team}/workflow/{workflow}?version=56,withTasks=true
Retrieve a version of the Workflow. Defaults to latest. Optionally without Tasks
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| version | Integer | false | Workflow Version | Defaults to null. | 56 |
| withTasks | Boolean | false | Include Workflow Tasks | Defaults to true. | true |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Search for Workflows
GET /api/v2/team/{team}/workflow/query?labels=,statuses=active,inactive,workflows=,limit=10,page=0,sort=ASC
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| limit | Integer | true | Result Size | Defaults to null. | 10 |
| page | Integer | true | Page Number | Defaults to null. | 0 |
| sort | String | true | Ascending (ASC) or Descending (DESC) sort on creationDate | Defaults to Optional[ASC]. Enum: [ASC, DESC] | ASC |
| labels | List | false | List of url encoded labels. For example Organization=Boomerang,customKey=test would be encoded as Organization%3DBoomerang,customKey%3Dtest) | Defaults to null. | |
| statuses | List | false | List of statuses to filter for. Defaults to all. | Defaults to null. | active,inactive |
| workflows | List | false | List of workflows to filter for. | Defaults to null. |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Submit a Workflow to be run. Will queue the WorkflowRun ready for execution.
POST /api/v2/team/{team}/workflow/{workflow}/submit?start=true
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | true | Owning team name. | Defaults to null. | my-amazing-team |
| workflow | String | true | Workflow reference | Defaults to null. | workflow_example |
| start | Boolean | false | Start the WorkflowRun immediately after submission | Defaults to false. | true |
Request Body
| Schema | Required |
|---|---|
| WorkflowSubmitRequest | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
Request Headers
- Content-Type:
application/json - Accept:
*/*