Effect Queues

The effect queues API allows you to manage effect queues in Firebot.

GET/queues

List all effect queues

Retrieves a list of all effect queues

Request

GET

/queues

curl http://localhost:7472/api/v1/queues

Response

[
  {
    "id": "queue1",
    "name": "Queue 1",
    "status": "active"
  },
  {
    "id": "queue2",
    "name": "Queue 2",
    "status": "paused"
  }
]

GET/queues/:queueId

Retrieve an effect queue

Fetches a specific effect queue by its queueId.

URL Parameters

Name
queueId
Type
string
Description
The unique identifier of the queue

Request

GET

/queues/queue1

curl http://localhost:7472/api/v1/queues/queue1

Response

{
  "id": "queue1",
  "name": "Queue 1",
  "status": "active"
}

POST/queues/:queueId/pause

Pause an effect queue

Pauses the specified effect queue.

URL Parameters

Name
queueId
Type
string
Description
The unique identifier of the queue

Request

POST

/queues/queue1/pause

curl -X POST http://localhost:7472/api/v1/queues/queue1/pause

Response

{
  "id": "queue1",
  "name": "Queue 1",
  "status": "paused"
}

POST/queues/:queueId/resume

Resume an effect queue

Resumes the specified effect queue.

URL Parameters

Name
queueId
Type
string
Description
The unique identifier of the queue

Request

POST

/queues/queue1/resume

curl -X POST http://localhost:7472/api/v1/queues/queue1/resume

Response

{
  "id": "queue1",
  "name": "Queue 1",
  "status": "active"
}

POST/queues/:queueId/toggle

Toggle an effect queue

Toggles the status of the specified effect queue (pauses if active, resumes if paused).

URL Parameters

Name
queueId
Type
string
Description
The unique identifier of the queue

Request

POST

/queues/queue1/toggle

curl -X POST http://localhost:7472/api/v1/queues/queue1/toggle

Response

{
  "id": "queue1",
  "name": "Queue 1",
  "status": "paused"
}

POST/queues/:queueId/clear

Clear an effect queue

Clears the specified effect queue (removes the queue).

URL Parameters

Name
queueId
Type
string
Description
The unique identifier of the queue

Request

POST

/queues/queue1/clear

curl -X POST http://localhost:7472/api/v1/queues/queue1/clear

Response

{
  "id": "queue1",
  "name": "Queue 1",
  "status": "removed"
}