Set up a queue
Create a queue in the dashboard when its jobs need something other than the defaults: a longer timeout, different retry delays, a concurrency limit or assertions. If the defaults suit you, skip this page: POST /api/jobs creates a queue by name the first time you use it. What each setting does is listed in Queues.
Create a queue
- Go to Queues and click New queue.
- Enter a Queue name. Your API calls must send this exact name as
queue. - Set the Request timeout in seconds, or click a preset (10s, 30s, 60s, 2m, 5m).
- Keep Enable automatic retries ticked to retry failed jobs. Under Retry delays, each Retry N row is the wait before that retry, in seconds:
- type a number or click a preset (1m, 5m, 30m, 1h, 3h)
- Add appends a retry with double the last delay, and the trash icon removes one
- the Retry schedule line sums it up, for example “after 1m, then after 30m, then after 3h”
- Optionally set Max concurrent jobs (leave it empty for unlimited) and pick a Dead letter retention.
- Optionally click Add assertion under Success assertions to add response checks (assertion types).
- Keep Enable this queue ticked, and decide whether to keep Enable email alerts for job failures.
- Click Create Queue.
Edit a queue
Click the pencil icon in the Queues list, or Edit on the queue’s page. Change what you need and click Update Queue. The new settings apply from the next attempt that starts, including jobs that are already waiting.
Pause and resume a queue
On the edit page, untick Enable this queue and click Update Queue. There’s no pause switch in the list. While the queue is paused, Delay holds its jobs as Pending instead of running them, and the API keeps accepting new ones. Tick the box again to resume: jobs that came due during the pause start within about a minute. Details: Pausing a queue.
See a queue’s jobs
The queue’s page shows its settings, a 30-day response time chart and the cards Total runs, Completed and Failed. It doesn’t list the jobs. To see them, go to Jobs and pick the queue in the All queues filter.
The Failed card doesn’t count dead-lettered jobs. Find those under Dead letters.
Delete a queue
In the Queues list, open the row’s More actions menu, click Delete and confirm in the Delete queue dialog. You can also click Delete on the queue’s page.
Next steps
- Queues: every setting with its default and limits.
- Retries and queue design: choose retry delays and decide how to split queues.
- Send a one-off or delayed request: put jobs on your queue.