Tasks
Tasks are work instances within a workflow
Required parameters:
Organization ID. Visible in Settings.
Queue ID. Found in the URL when inside a queue.
The task object
A task is defined by the following properties:
id
- A unique task identifier.status
- The task's status, which can benew
,open
,in_progress
orcompleted
.completed_at
. ISO 8601 formatted timestamp.created_at
. ISO 8601 formatted timestamp.completed_by
. The user's email address.queue
. The queue name.queue_id
. A unique identifier for the queue the task belongs to.data
. A dictionary with all the attributes that characterize the queue, 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 takeapi
,zapier
,manual
or$filename.csv
as its value.
An example task would look like this:
Create a task
POST
https://api.humanlambdas.com/orgs/$ORGANIZATION_ID/queues/$QUEUE_ID/tasks/create
This endpoint creates a task.
Path Parameters
Name | Type | Description |
---|---|---|
ORGANIZATION_ID | integer | The ID of your organization. |
QUEUE_ID | string | The ID of your queue. |
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
Authorization | string | Your API Key (see Introduction for more details). |
Request Body
Name | Type | Description |
---|---|---|
data | object | The workflow specific attributes that you want to include in this task. |
Sample request:
List a queue's completed tasks
GET
https://api.humanlambdas.com/orgs/$ORGANIZATION_ID/queues/$QUEUE_ID/tasks/completed
This endpoint returns a list of a queue's completed tasks.
Path Parameters
Name | Type | Description |
---|---|---|
ORGANIZATION_ID | integer | The ID of your organization. |
QUEUE_ID | string | The ID of your queue. |
Query Parameters
Name | Type | Description |
---|---|---|
offset | integer | The starting index in the returned list. See Pagination for more details. |
limit | integer | The maximum number of items to include in the response. See Pagination for more details. |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Your API Key (see Introduction for more details). |
Last updated