Reference

Workers API Reference

interface WorkerMetadata {
  queue: string;
  endpoint: EndpointOptions;
  opts?: WorkerOptions;
}

interface EndpointOptions {
    url: string;
    method: "post" | "get" | "put" | "delete" | "patch";
    headers?: Record<string, string>;
    timeout?: number; // max allowed duration in milliseconds
}

interface WorkerOptions {
  concurrency?: number;
  limiter?: {
    max: number; // integer representing max number of jobs to process on "duration"
    duration: number: // number of millisecons
  };
  removeOnComplete?: {
    count?: number;
    age?: number;
  };
  removeOnFail?: {
    count?: number;
    age?: number;
  };
  maxStalledCount?: number;
}

Workers API

Add / Update a worker

POST /workers

Adds a new worker or updates an existing one.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
queue	string	Name of the queue
endpoint	Endpoint	Endpoint options
opts	WorkerOptions	Options for the worker

Response

200

"OK"

400

Remove worker

DELETE /workers/:queue-name

Removes an existing worker for a given queue.

Headers

Name	Value
Authorization	Bearer <token>

Response

200

"OK"

404

Get workers

GET /workers

Gets all the workers registered in the proxy.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

{
  "queue-name": "url"
}