Job Runner
Manage scheduled HTTP jobs and trigger them on demand.
Job Runner API
List Jobs
GET
Required permission
job_runner:readApiAccessPermission::JOB_RUNNER_READQuery Parameters
sizeintegerRecords per page (default 50, max 100).
pageintegerPage number starting from 1.
Responses
Job runner list returned.
{
"entities": "JobRunner",
"count": 1,
"per_page": 50,
"pages": {
"current": 1,
"max": 1
},
"elements": [
{
"id": "681f10...",
"title": "Sync CRM Contacts",
"method": "POST",
"url": "https://api.partner.com/sync",
"content_type": "application/json",
"has_body": true,
"schedulation": [
"08:00",
"14:30"
]
}
]
}Create Job
POST
Required permission
job_runner:writeApiAccessPermission::JOB_RUNNER_WRITEQuery Parameters
No query parameters required.
Request Body
{
"jobrunner": {
"title": "Sync CRM Contacts",
"method": "POST",
"url": "https://api.partner.com/sync",
"content_type": "application/json",
"body": "{\"scope\":\"daily\"}",
"schedulation": [
"08:00",
"14:30"
]
}
}jobrunnerobjectRequiredJob runner configuration payload.
Responses
Job runner created.
{
"id": "681f10...",
"created": true
}Validation error on payload.
{
"error": "Invalid schedulation time \"24:30\". Use HH:mm format"
}Run Job
POST
Required permission
job_runner:writeApiAccessPermission::JOB_RUNNER_WRITEQuery Parameters
jobRunnerIdstringRequiredJob runner identifier.
Responses
Job execution completed.
{
"job_runner_id": "681f10...",
"status": "success",
"headers": [
"HTTP/1.1 200 OK"
],
"response": "{\"ok\":true}",
"ms": 122.45
}Delete Job
DELETE
Required permission
job_runner:writeApiAccessPermission::JOB_RUNNER_WRITEQuery Parameters
jobRunnerIdstringRequiredJob runner identifier.
Responses
Job runner deleted.
{
"id": "681f10...",
"deleted": true
}