Skip to main content

​
Global

dispatchq --help
dispatchq --version
dispatchq --api-key <key> --api-url <url> <command>

​
Jobs

​
Create

dispatchq jobs create --url https://example.com/webhook [options]
Options:
  • --url <url> required
  • --method <method> default POST
  • --payload <json>
  • --delay <delay> (30s, 5m, 1h, 1d)
  • --queue <name> default default
  • --max-attempts <n> default 3
  • --dedupe-key <key>
  • --callback-url <url>
  • --requires-approval
  • --idempotency-key <key>
Example: 
dispatchq jobs create \
  --url https://example.com/webhook \
  --payload '{"task":"send-email"}' \
  --delay 5m \
  --queue outbound \
  --max-attempts 5 \
  --idempotency-key req_123

​
Get

dispatchq jobs get job_V1StGXR8_Z5j

​
List

dispatchq jobs list [options]
Options:
  • --status <status>
  • --queue <name>
  • --limit <n> default 20
  • --offset <n> default 0
Example: 
dispatchq jobs list --status failed --queue outbound --limit 10 --offset 0

​
Cancel

dispatchq jobs cancel <job_id>

​
Approve

dispatchq jobs approve <job_id>

​
Retry

dispatchq jobs retry <job_id>

​
Schedules

​
Create

dispatchq schedules create --cron <expr> --url <url> [options]
Options:
  • --cron <expr> required
  • --url <url> required
  • --method <method> default POST
  • --payload <json>
  • --timezone <tz> default UTC
Example: 
dispatchq schedules create \
  --cron "*/5 * * * *" \
  --url https://example.com/heartbeat \
  --payload '{"type":"heartbeat"}' \
  --timezone America/Los_Angeles

​
List

dispatchq schedules list --limit 20 --offset 0

​
Get

dispatchq schedules get <schedule_id>

​
Delete

dispatchq schedules delete <schedule_id>

​
Health

dispatchq health
All command responses are printed as pretty JSON, with colorized status values.