Skip to content

Run a job immediately

POST
/api/v1/cron/{name}/run
curl --request POST \
--url http://localhost:11044/api/v1/cron/example/run \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Fires the named cron job outside its normal schedule and runs it inline: the request blocks until the job completes. Output goes to the active chat session when there is one, otherwise to a notification channel.

name
required
string

Job name

Job ran to completion

Media type*/*
object
key
additional properties
string

Job not found

Media type*/*

A refusal from the cron or handler-adoption surface: the word error and the reason

object
message
required

Why the request was refused, written to be shown. Names the job or handler where the refusal is about one

string
status
required

Always error

string
Allowed values: error