Skip to main content
POST
Create Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for job.CreateJobRequest

CreateJobRequest schema

method
string
required

The HTTP method used when sending the request.

Example:

"POST"

name
string
required

A unique name for the job. Used for identification.

Example:

"Database Backup"

url
string
required

The URL the job will send a request to.

Example:

"https://example.com"

body
string | null

Optional request body to include when sending the job.

headers
object

Optional key/value pairs of HTTP headers to include in the request.

run_at
string<date-time> | null

A timestamp for running the job once at a specific time. Must be in RFC3339 format, e.g. 2025-09-24T17:00:00Z. Ignored if schedule is provided.

schedule
string | null

A cron expression for running the job on a recurring schedule. If provided, it takes precedence over run_at.

Response

OK

Job schema

body
string
headers
object
id
string
Example:

"job_xxx"

method
string
Example:

"POST"

name
string
Example:

"Job"

next_run_at
string<date-time> | null

The next time the Job is scheduled to run. If empty, the Job is complete=.

schedule
string | null

The CRON schedule for the Job

Example:

"0 12 * * *"

status
string

A Job can be active, paused, failed or completed

Example:

"active"

url
string
Example:

"https://example.com"