← Workly docs

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.

MethodPathWhat it does
GET/healthzLiveness probe
GET/readyzReadiness probe
GET/v1/queuesList 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}/pausePause a queue
POST/v1/queues/{queue}/resumeResume a paused queue
POST/v1/queues/{queue}/cancel-pendingCancel a queue's pending tasks
POST/v1/queues/{queue}/retry-failedRetry every failed task in a queue
GET/v1/queues/{queue}/failuresGroup a queue's failed tasks by error
GET/v1/queues/{queue}/activityCount a queue's finished tasks
GET/v1/activityCount tasks created and finished over time
GET/v1/queues/{queue}/tasksList a queue's tasks
POST/v1/queues/{queue}/tasksEnqueue a task
POST/v1/queues/{queue}/tasks:batchEnqueue up to 100 tasks at once
GET/v1/tasksSearch tasks across queues
GET/v1/tasks/{id}Get a task
GET/v1/tasks/{id}/attemptsList a task's delivery attempts, oldest first
GET/v1/tasks/{id}/deliveryGet the request that delivers a task
POST/v1/tasks/{id}/cancelCancel a task
POST/v1/tasks/{id}/retryRetry a task now
GET/v1/groupsList task groups
POST/v1/groupsCreate a task group
GET/v1/groups/{id}Get a task group
POST/v1/groups/{id}/closeClose a task group
GET/v1/schedulesList 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/previewPreview a cron timetable
POST/v1/schedules/{schedule}/pausePause a schedule
POST/v1/schedules/{schedule}/resumeResume a paused schedule
POST/v1/schedules/{schedule}/triggerRun a schedule now
GET/v1/runsList runs, newest first
GET/v1/runs/{id}Get a run
GET/v1/runs/{id}/attemptsList a run's delivery attempts, oldest first
GET/v1/runs/{id}/deliveryGet the request that delivers a run
POST/v1/runs/{id}/cancelCancel a run
POST/v1/runs/{id}/retryRetry a run now
GET/v1/workflowsList 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}/runsStart a workflow run
GET/v1/workflow-runsList workflow runs, newest first
GET/v1/workflow-runs/{id}Get a workflow run with its steps
POST/v1/workflow-runs/{id}/cancelCancel a workflow run
POST/v1/workflow-runs/{id}/retryRetry a workflow run
GET/v1/alert-channelsList alert channels
POST/v1/alert-channelsAdd an alert channel
DELETE/v1/alert-channels/{id}Remove an alert channel
POST/v1/alert-channels/{id}/testSend a test alert