Workly API reference
Every endpoint of the HTTP API. The full contract, with every request and response schema, is the OpenAPI spec: https://workly.run/docs/api/openapi.yaml. Requests to /v1 take Authorization: Bearer $WORKLY_API_KEY; hosted Workly is athttps://api.workly.run.
| Method | Path | What it does |
|---|---|---|
GET | /healthz | Liveness probe |
GET | /readyz | Readiness probe |
GET | /v1/queues | List queues |
GET | /v1/queues/{queue} | Get a queue |
PUT | /v1/queues/{queue} | Create or update a queue |
DELETE | /v1/queues/{queue} | Delete a queue and all its tasks |
POST | /v1/queues/{queue}/pause | Pause a queue |
POST | /v1/queues/{queue}/resume | Resume a paused queue |
POST | /v1/queues/{queue}/cancel-pending | Cancel a queue's pending tasks |
POST | /v1/queues/{queue}/retry-failed | Retry every failed task in a queue |
GET | /v1/queues/{queue}/failures | Group a queue's failed tasks by error |
GET | /v1/queues/{queue}/activity | Count a queue's finished tasks |
GET | /v1/activity | Count tasks created and finished over time |
GET | /v1/queues/{queue}/tasks | List a queue's tasks |
POST | /v1/queues/{queue}/tasks | Enqueue a task |
POST | /v1/queues/{queue}/tasks:batch | Enqueue up to 100 tasks at once |
GET | /v1/tasks | Search tasks across queues |
GET | /v1/tasks/{id} | Get a task |
GET | /v1/tasks/{id}/attempts | List a task's delivery attempts, oldest first |
GET | /v1/tasks/{id}/delivery | Get the request that delivers a task |
POST | /v1/tasks/{id}/cancel | Cancel a task |
POST | /v1/tasks/{id}/retry | Retry a task now |
GET | /v1/groups | List task groups |
POST | /v1/groups | Create a task group |
GET | /v1/groups/{id} | Get a task group |
POST | /v1/groups/{id}/close | Close a task group |
GET | /v1/schedules | List schedules |
GET | /v1/schedules/{schedule} | Get a schedule |
PUT | /v1/schedules/{schedule} | Create or update a schedule |
DELETE | /v1/schedules/{schedule} | Delete a schedule and all its runs |
GET | /v1/cron/preview | Preview a cron timetable |
POST | /v1/schedules/{schedule}/pause | Pause a schedule |
POST | /v1/schedules/{schedule}/resume | Resume a paused schedule |
POST | /v1/schedules/{schedule}/trigger | Run a schedule now |
GET | /v1/runs | List runs, newest first |
GET | /v1/runs/{id} | Get a run |
GET | /v1/runs/{id}/attempts | List a run's delivery attempts, oldest first |
GET | /v1/runs/{id}/delivery | Get the request that delivers a run |
POST | /v1/runs/{id}/cancel | Cancel a run |
POST | /v1/runs/{id}/retry | Retry a run now |
GET | /v1/workflows | List workflows |
GET | /v1/workflows/{workflow} | Get a workflow |
PUT | /v1/workflows/{workflow} | Create or update a workflow |
DELETE | /v1/workflows/{workflow} | Delete a workflow |
POST | /v1/workflows/{workflow}/runs | Start a workflow run |
GET | /v1/workflow-runs | List workflow runs, newest first |
GET | /v1/workflow-runs/{id} | Get a workflow run with its steps |
POST | /v1/workflow-runs/{id}/cancel | Cancel a workflow run |
POST | /v1/workflow-runs/{id}/retry | Retry a workflow run |
GET | /v1/alert-channels | List alert channels |
POST | /v1/alert-channels | Add an alert channel |
DELETE | /v1/alert-channels/{id} | Remove an alert channel |
POST | /v1/alert-channels/{id}/test | Send a test alert |