Skip to content
v3.4Schedules now run in any time zone

Halyard documentation

Background work, handled.

Everything you need to queue jobs, schedule recurring work and fan out events with Halyard: guides, API reference, SDKs and the CLI.

~/acme-api — halyard
$ halyard jobs tail --queue allStreaming live jobs from production (us-east) … 14:02:11  succeeded  job_3Rk9Tq7Xw2  send-welcome-email  182ms14:02:11  succeeded  job_7Mp2Lc4Vn8  resize-avatar  641ms14:02:12  retrying  job_9Qe1Hs6Zt3  sync-crm-contact  attempt 2/514:02:12  running  job_2Wd8Nf5Kb1  build-invoice-pdf14:02:13  queued  job_5Xa4Rj9Pg6  send-welcome-email $ 
3 workers online · 1,284 jobs / min live

Quickstart

Start in 5 minutes

Queue a job, run a worker and watch it succeed. You only need an API key and a terminal.

  1. 1

    Create a test key

    Sign up and copy the key that starts with hy_test_. Test keys run in a sandbox and never bill.

    30 seconds

  2. 2

    Queue your first job

    Send one request with a queue, a task name and a JSON payload. Halyard answers with the job's ID.

    1 minute

  3. 3

    Run a worker

    Start halyard dev or an SDK worker. It picks up the job, runs your handler and reports the result.

    3 minutes

curl https://api.halyard.example/v3/jobs \  -H "Authorization: Bearer hy_test_51Hq8Zx2rTmV9cKpL3d" \  -H "Content-Type: application/json" \  -d '{    "queue": "emails",    "task": "send-welcome-email",    "payload": { "user_id": "usr_8KfQ2" }  }'

Explore

Everything Halyard runs

Six building blocks cover almost every kind of background work. Start with the one you need today.

SDKs

Official libraries

Typed clients and workers for the languages you already use. Every SDK covers the full v3 API.

Guides

Popular guides

  1. 01Send welcome emails in the backgroundJobs6 min
  2. 02Process image uploadsQueues9 min
  3. 03Fan out events to many servicesEvents8 min
  4. 04Build a nightly reportSchedules7 min
  5. 05Make jobs idempotentJobs5 min
Browse all guides

API reference

A small, predictable REST API

JSON in, JSON out. Authenticate with a bearer key, retry safely with Idempotency-Key and page through lists with cursors. Open the reference.

Help

Stuck? We're around.

Real engineers answer support, and the status page is updated by the on-call team, not a bot.

Support

Email us, ask the community or book office hours. Pro plans get answers within 4 business hours.

Halyard Community · 4,200 members

System status

All systems operational99.99% API uptime · last 90 days

ChangelogLatest v3.4.0

Schedules with time zones, queue pausing and a faster dashboard.

Released October 14, 2026

Suggested