Workflow: Queues


Queues group tickets by who works on them, such as a maintenance team or a contractor. Each ticket sits in one queue, and each queue is linked to user groups.

Users in a queue's user groups can see and update the tickets in it, and are notified when a ticket is raised in the queue or moved into it. Power users can see every ticket regardless of queue.

This article will cover how to manage queues and their user groups. You can read about tickets in Workflow: Tickets.

Data model

interface IQueue {
    // Unique ID for the queue.
    // Exclude this value for new records.
    ID?: number;
    // Human readable name. Limited to 30 characters.
    DisplayName: string;
    // Description of what the queue is for.
    Description?: string;
    // Only returned when requesting a queue by ID.
    // IDs of the user groups linked to the queue.
    "UserGroup.ID"?: string[];
}

Requesting records

Get a list of queues

Response
interface IResponse {
    // Queues without their user groups.
    Items: IQueue[];
}
Javascript example

Get queue by ID

Response
// The response is the queue record directly, including "UserGroup.ID".
Javascript example

Create and update records

You can create a queue by setting the ID as '0', or update one by its ID. When updating, only the properties you include are changed. User groups are managed with the requests in the next section.

Create or update queue

Request body
// Body should be the queue JSON as specified above.
Response
// The response is the queue record directly.
Javascript example

Delete a record

A queue cannot be deleted while a ticket or schedule still uses it. Move those to another queue first.

Delete queue

Javascript example

Queues: User groups

You can link user groups to a queue or unlink them.

Add user groups to a queue

Request body
interface IBody {
    "UserGroup.ID": string[];
}
Javascript example

Remove user groups from a queue

Request body
interface IBody {
    "UserGroup.ID": string[];
}
Javascript example