Skip to main content
POST
Create Job

Authorizations

Authorization
string
header
required

Provide your QuedUp API key in the Authorization header as Bearer <api_key>.

Body

application/json

Payload used to create a new scheduled HTTP job.

name
string
required

Human-readable name for the job.

Minimum string length: 1
Example:

"Nightly customer sync"

url
string<uri>
required

Destination URL that QuedUp should call when the job runs.

Minimum string length: 1
Example:

"https://api.example.com/webhooks/customer-sync"

method
enum<string>
required

HTTP method used when QuedUp executes the job request.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"POST"

headers
object

Optional HTTP headers to include in the outbound request.

Example:
schedule
string

Cron expression for a recurring job. Takes precedence over run_at when both are provided.

Example:

"0 0 * * *"

run_at
string<date-time>

ISO 8601 timestamp for a one-time execution.

Example:

"2026-03-09T00:00:00.000Z"

body
string

Optional raw request body to send with the job request.

Example:

"{\"source\":\"quedup\",\"action\":\"sync\"}"

Response

A scheduled HTTP job managed by QuedUp.

id
string
required

Unique identifier for the job.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

Human-readable name for the job.

Example:

"Nightly customer sync"

url
string<uri>
required

Destination URL that QuedUp calls when the job runs.

Example:

"https://api.example.com/webhooks/customer-sync"

method
enum<string>
required

HTTP method used when QuedUp executes the job request.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"POST"

headers
object
required

HTTP headers that will be sent with the outbound request.

Example:
body
string
required

Raw request body sent when the job executes.

Example:

"{\"source\":\"quedup\",\"action\":\"sync\"}"

schedule
string | null
required

Cron expression for recurring execution. Null for one-time jobs.

Example:

"0 0 * * *"

next_run_at
string<date-time> | null
required

Next scheduled execution time in ISO 8601 format.

Example:

"2026-03-09T00:00:00.000Z"

status
enum<string>
required

Current lifecycle state of the job.

Available options:
active,
paused,
failed,
completed,
running
Example:

"active"