Labels

Labels can be used to categorize tasks and manage task workflows according to your specific business needs. Each task can be associated with a maximum of 100 labels. Labels are an organizational tool that have no effect on system behavior.

Use Cases

Common use cases include:

• Tasks that can't be completed yet might have a blocked or onHold label.
• Tasks that require review and approval by a manager might have a pendingReview or escalated label.
• Tasks that require action from a customer might have an awaitingCustomer or pendingSignature label.

Configuration

Before labels can be associated with a task, labels must be configured through LabelRef configuration objects within the WorkManagementRef tenant configuration.

Here's an example of a WorkManagementRef configuration that includes blocked, escalated, and awaitingCustomer labels:

{
	"labels": {
		"blocked": {},
		"escalated": {},
		"awaitingCustomer": {}
	}
}

Adding Labels to Tasks

Task Dashboard

Once your configuration changes have been deployed, you can start adding labels to tasks within the Task Dashboard.

Access the Task Dashboard by navigating to the Operations Workbench and selecting a tenant.

You can add labels to existing tasks in the task summary table by clicking the + or Add label + button in the label column.

You can also add labels when creating a new task in the task sidebar.

Search for tasks with a specific label by using the label filter in the Task Dashboard.

API Endpoints

You can also add labels to tasks when creating and updating tasks through the Add Task and Update Task API endpoints.

Here's an example request for the Add Task API endpoint:

{
	"type": "underwriting",
	"deadlineTime": "2027-01-15T09:30:00Z",
	"references": [
		{
			"referenceType": "quote",
			"referenceLocator": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
		}
	],
	"labels": ["blocked", "escalated"]
}

Here's an example request for the Update Task API endpoint:

{
	"addLabels": ["awaitingCustomer"]
}