Tasks

Tasks are work instances within a workflow

Required parameters:

  • Organization ID. Visible in Settings.

  • Workflow ID. Found in the URL when inside a workflow.

The task object

A task is defined by the following properties:

  • id - A unique task identifier.

  • status - The task's status, which can be new, open, in_progress or completed.

  • completed_at. ISO 8601 formatted timestamp.

  • created_at. ISO 8601 formatted timestamp.

  • completed_by. The user's email address.

  • workflow. The workflow's name.

  • workflow_id. A unique identifier for the workflow the task belongs to.

  • data. A dictionary with all the attributes that characterize the workflow, according to its user defined configuration. Each key nested in the object takes the name of each block's identifier. See Blocks to learn more.

  • source. The name of the source that originated the task. Can take api , zapier, manual or $filename.csv as its value.

An example task would look like this:

{
"id": 169578,
"status": "completed",
"completed_at": "2020-10-08T12:56:04.206Z",
"created_at": "2020-10-08T12:55:08.546Z",
"completed_by": "joe@example.com",
"workflow": "Sample Workflow Name",
"workflow_id": 79,
"data": {
"comment": "A random benign comment that needs to get approved"
"approve": true
},
"source": "api"
}

post
Create a task

https://api.humanlambdas.com/orgs/$ORGANIZATION_ID/workflows/$WORKFLOW_ID/tasks/create
This endpoint creates a task.
Request
Response
Request
Path Parameters
ORGANIZATION_ID
required
integer
The ID of your organization.
WORKFLOW_ID
required
string
The ID of your workflow.
Headers
Content-Type
required
string
application/json
Authorization
required
string
Your API Key (see Introduction for more details).
Body Parameters
data
required
object
The workflow specific attributes that you want to include in this task.
Response
200: OK
Task successfully created.
{
"completed_at": null,
"completed_by": null,
"created_at": "2020-10-08T15:27:08.632837Z",
"data": {
"approve": null,
"comment": "This is some random text"
},
"id": 169581,
"inputs": [],
"outputs": [],
"source": "api",
"status": "new",
"workflow": "Moderate Comments",
"workflow_id": 166
}

Sample request:

curl -v https://api.humanlambdas.com/orgs/$ORGANIZATION_ID/workflows/$WORKFLOW_ID/tasks/create \
-H "Content-Type: application/json" \
-H "Authorization: Token $API_KEY" \
-d '{"data":
{
"comment": "This is some random text"
}
}'

get
List a workflow's completed tasks

https://api.humanlambdas.com/orgs/$ORGANIZATION_ID/workflows/$WORKFLOW_ID/tasks/completed
This endpoint returns a list of a workflow's completed tasks.
Request
Response
Request
Path Parameters
ORGANIZATION_ID
required
integer
The ID of your organization.
WORKFLOW_ID
required
string
The ID of your workflow.
Headers
Authorization
required
string
Your API Key (see Introduction for more details).
Query Parameters
offset
optional
integer
The starting index in the returned list. See Pagination for more details.
limit
optional
integer
The maximum number of items to include in the response. See Pagination for more details.
Response
200: OK
Returns a list of completed tasks:
{
"count": 2,
"next": null,
"previous": null,
"tasks": [
{
"completed_at": "2020-10-08T16:28:22.633450Z",
"completed_by": "joe@example.com",
"created_at": "2020-10-08T16:28:16.408194Z",
"data": {
"approve": false,
"comment": "This sucks..."
},
"id": 169583,
"source": "manual",
"status": "completed",
"workflow": "Moderate Comments",
"workflow_id": 166
},
{
"completed_at": "2020-10-08T15:28:33.664113Z",
"completed_by": "joe@example.com",
"created_at": "2020-10-08T15:27:08.632837Z",
"data": {
"approve": true,
"comment": "This is some random text"
},
"id": 169581,
"source": "api",
"status": "completed",
"workflow": "Moderate Comments",
"workflow_id": 166
}
]
}