Automation
Run an atomic Job Template batch.
Accepts 1 to 100 Job requests, at most 5 MiB of UTF-8 JSON. Requires an idempotencyKey. The same key with a different payload returns 409. ROLES: AUTOMATION_RUNNER, AUTOMATION_ADMIN. USER: true. SERVICE ACCOUNT: true.
POST
/
api
/
v1
/
automation
/
templates
/
run
Run an atomic Job Template batch.
curl --request POST \
--url https://api.revoengine.com/api/v1/automation/templates/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"trigger": {
"input": {},
"metadata": {},
"type": "<string>",
"message": {}
},
"options": {
"scheduleFor": "2023-11-07T05:31:56Z"
}
}
],
"idempotencyKey": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
name: '<string>',
trigger: {input: {}, metadata: {}, type: '<string>', message: {}},
options: {scheduleFor: '2023-11-07T05:31:56Z'}
}
],
idempotencyKey: '<string>'
})
};
fetch('https://api.revoengine.com/api/v1/automation/templates/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revoengine.com/api/v1/automation/templates/run"
payload = {
"items": [
{
"name": "<string>",
"trigger": {
"input": {},
"metadata": {},
"type": "<string>",
"message": {}
},
"options": { "scheduleFor": "2023-11-07T05:31:56Z" }
}
],
"idempotencyKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)[
"<string>"
]Authorizations
Bearer JWT token or API Key (sk-*).
Body
application/json
Ordered Job requests, accepted atomically. The complete request has a 5 MiB UTF-8 JSON limit.
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Required retry identity. Reuse the same key and ordered payload to receive the original Job IDs. A different payload under the same key conflicts.
Maximum string length:
128Response
201 - application/json
Ordered Job IDs, atomically accepted. Identical retries return the original IDs.
⌘I
Run an atomic Job Template batch.
curl --request POST \
--url https://api.revoengine.com/api/v1/automation/templates/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"trigger": {
"input": {},
"metadata": {},
"type": "<string>",
"message": {}
},
"options": {
"scheduleFor": "2023-11-07T05:31:56Z"
}
}
],
"idempotencyKey": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
name: '<string>',
trigger: {input: {}, metadata: {}, type: '<string>', message: {}},
options: {scheduleFor: '2023-11-07T05:31:56Z'}
}
],
idempotencyKey: '<string>'
})
};
fetch('https://api.revoengine.com/api/v1/automation/templates/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revoengine.com/api/v1/automation/templates/run"
payload = {
"items": [
{
"name": "<string>",
"trigger": {
"input": {},
"metadata": {},
"type": "<string>",
"message": {}
},
"options": { "scheduleFor": "2023-11-07T05:31:56Z" }
}
],
"idempotencyKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)[
"<string>"
]