Create Job
This endpoint creates a new job
Body
The HTTP method to use. One of get
, post
, put
, patch
, delete
.
The URL to send the HTTP request to. Must use https.
Optional query parameters to pass through to the request.
Optional request body to pass through to the request.
Supports dynamic fields such as $job
, $state
, and $previous
for recurring
jobs. Learn more about dynamic fields here.
Optional request headers to pass through to the request.
How long to wait before executing the request. Set either as a number of
seconds, or a tuple such as [5, "minutes"]
.
If you’d rather specify a timestamp at which to run the request, use the scheduled_at
field instead.
The timestamp at which to execute the request. Set either as a datetime
string, or a unix timestamp.
If you want to schedule the request relative to now (e.g. “in 5 mins”), use the
schedule_in
field instead.
Setting this field will put the job on a recurring schedule. Set as either a
number of seconds, or a tuple such as [5, "minutes"]
The cron expression used to set the job on a recurring schedule.
For example, */5 * * * *
would run every 5 minutes, 0 9 * * 1-5
runs
every Mon-Fri at 9am UTC.
A value used to enforce idempotency, or uniqueness.
For example, if multiple jobs are scheduled with the same idempotency_key
before
one of them is executed, every job but the first one will be ignored.
A callback URL to send the result of the HTTP request to. Must use https.
A webhook URL to send job events to. Must use https. Job events include:
job.started
, job.request
, job.response
, job.finished
, job.error
.
Headers
API key