Rivier/ Reference/ workspace

Hold a job until its time, once or every so often

post/jobs

Hold a job until its time, once or every so often. It arrives as the event jobs., signed, at the project's webhooks that listen for it. The same idempotency key never makes a second job.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Mcp
rivier_job_create
Graphql
Mutation.workspaceJobCreate
Sdk
workspace.job.create
Cli
workspace job create

Request bodyapplication/json, required

  • namestringrequired
    Pattern: ^[a-z0-9][a-z0-9_.-]{0,59}$.
  • dataobject
    Default: {}.
  • runAtstring (date-time)
  • everySecondsinteger
    At least 60. At most 2678400.
  • idempotencyKeystring
    At most 120 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown