Workflows
Overview
The Workflow resources represents the stages of an automation that -in its simplest form- will transform source data to output documents.
Fields
Field | Type | Editable | Description |
---|---|---|---|
id | String | The unique ID of the workflow. This is used to reference the specific workflow in all requests. | |
name | String | The name of the workflow. | |
color | String | The colour of the workflow icon in Portant Workflow as a hex string, prefixed with | |
icon | String | The name of the icon used in Portant Workflow | |
status | String | The current status of the workflow. Can be one of the following: - "COMPLETE": The workflow is runnable - "INCOMPLETE": The workflow requires further configuration before it can be run - "ARCHIVED": The workflow is no longer usable | |
autoCreate | Boolean | The workflow will be listening to events via its source and will create a new automation when the autoCreate flag is enabled. | |
owner | The owner of this workflow. | ||
team | The team this workflow belongs to. | ||
source | The source of data for this workflow. | ||
documents | The template documents for this workflow. | ||
outgoingWebhook | Outgoing Webhook | The outgoing webhook of this workflow, used to listen for automation events from the workflow. | |
createdByApi | Boolean | Flag indicating this workflow was created via the Developer API | |
createdAt | String | An ISO Format timestamp representing when the workflow was created. | |
updatedAt | String | An ISO Format timestamp representing when the workflow was last updated. |
Example
Endpoints
List all Workflows
Retrieve the list of Workflow objects that are owned by- or shared with the team of the user of the API.
Responses
Status | Body |
---|---|
200 OK | Array<Workflow> |
403 Unauthorised | Error |
Create a Workflow
Create a new workflow.
Request
A partial Workflow object as JSON.
The only field required to created the simplest form of workflow is the name
field.
Alternatively, an entire complete workflow can be created via a single POST request by providing the optional subcomponents with their respective required fields as outlined below.
Fields suffixed with ?
are not required.
Responses
Status | Body |
---|---|
201 Created | Workflow |
400 Bad Request | Error |
403 Unauthorised | Error |
Retrieve a Workflow
Retrieve a specific workflow via its id.
Responses
Status | Body |
---|---|
200 OK | Workflow |
403 Unauthorised | Error |
404 Not Found | Error |
Update a Workflow
Update a specific workflow via its id.
Request
A partial Workflow object as JSON. Fields suffixed with ?
are not required.
Response
Status | Body |
---|---|
200 OK | Workflow |
400 Bad Request | Error |
403 Unauthorised | Error |
404 Not Found | Error |
Delete a Workflow
Delete a specific workflow via its id. This method does not actually delete the workflow but sets its status to "ARCHIVED"
. Deleted workflows can be restored by contacting our custom success team.
Response
Status | Body |
---|---|
204 No Content | |
400 Bad Request | Error |
403 Unauthorised | Error |
404 Not Found | Error |
Last updated