Add an automation
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/automations \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"query": "<string>",
"query_type": "<string>",
"date": "2023-12-25",
"description": "<string>",
"is_active": true,
"notes": "<string>",
"run_at": 123,
"arguments": [
{
"name": "<string>",
"value": "<string>"
}
],
"actions": [
{
"name": "<string>",
"sort_order": 123,
"uuid": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>",
"is_dynamic": true
}
],
"description": "<string>",
"notes": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/automations"
payload = {
"name": "<string>",
"query": "<string>",
"query_type": "<string>",
"date": "2023-12-25",
"description": "<string>",
"is_active": True,
"notes": "<string>",
"run_at": 123,
"arguments": [
{
"name": "<string>",
"value": "<string>"
}
],
"actions": [
{
"name": "<string>",
"sort_order": 123,
"uuid": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>",
"is_dynamic": True
}
],
"description": "<string>",
"notes": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
query: '<string>',
query_type: '<string>',
date: '2023-12-25',
description: '<string>',
is_active: true,
notes: '<string>',
run_at: 123,
arguments: [{name: '<string>', value: '<string>'}],
actions: [
{
name: '<string>',
sort_order: 123,
uuid: '<string>',
arguments: [{name: '<string>', value: '<string>', is_dynamic: true}],
description: '<string>',
notes: '<string>'
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/automations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/automations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'query' => '<string>',
'query_type' => '<string>',
'date' => '2023-12-25',
'description' => '<string>',
'is_active' => true,
'notes' => '<string>',
'run_at' => 123,
'arguments' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'actions' => [
[
'name' => '<string>',
'sort_order' => 123,
'uuid' => '<string>',
'arguments' => [
[
'name' => '<string>',
'value' => '<string>',
'is_dynamic' => true
]
],
'description' => '<string>',
'notes' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/automations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"query_type\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"notes\": \"<string>\",\n \"run_at\": 123,\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"sort_order\": 123,\n \"uuid\": \"<string>\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"is_dynamic\": true\n }\n ],\n \"description\": \"<string>\",\n \"notes\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/automations")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"query_type\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"notes\": \"<string>\",\n \"run_at\": 123,\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"sort_order\": 123,\n \"uuid\": \"<string>\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"is_dynamic\": true\n }\n ],\n \"description\": \"<string>\",\n \"notes\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/automations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"query_type\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"notes\": \"<string>\",\n \"run_at\": 123,\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"sort_order\": 123,\n \"uuid\": \"<string>\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"is_dynamic\": true\n }\n ],\n \"description\": \"<string>\",\n \"notes\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"type": "<string>",
"query": "<string>",
"query_type": "<string>",
"date": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>"
}
],
"slot": "<string>",
"actions": [
{
"id": 123,
"uuid": "<string>",
"references_id": "<string>",
"name": "<string>",
"sort_order": 123,
"description": "<string>",
"notes": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>",
"is_dynamic": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>"
}
],
"description": "<string>",
"notes": "<string>",
"is_active": true,
"frequency": "<string>",
"run_at": 123,
"last_run_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Automation
Add an automation
A POST to the /automation endpoint allows your application to create an automation.
POST
/
v3
/
automations
Add an automation
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/automations \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"query": "<string>",
"query_type": "<string>",
"date": "2023-12-25",
"description": "<string>",
"is_active": true,
"notes": "<string>",
"run_at": 123,
"arguments": [
{
"name": "<string>",
"value": "<string>"
}
],
"actions": [
{
"name": "<string>",
"sort_order": 123,
"uuid": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>",
"is_dynamic": true
}
],
"description": "<string>",
"notes": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/automations"
payload = {
"name": "<string>",
"query": "<string>",
"query_type": "<string>",
"date": "2023-12-25",
"description": "<string>",
"is_active": True,
"notes": "<string>",
"run_at": 123,
"arguments": [
{
"name": "<string>",
"value": "<string>"
}
],
"actions": [
{
"name": "<string>",
"sort_order": 123,
"uuid": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>",
"is_dynamic": True
}
],
"description": "<string>",
"notes": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
query: '<string>',
query_type: '<string>',
date: '2023-12-25',
description: '<string>',
is_active: true,
notes: '<string>',
run_at: 123,
arguments: [{name: '<string>', value: '<string>'}],
actions: [
{
name: '<string>',
sort_order: 123,
uuid: '<string>',
arguments: [{name: '<string>', value: '<string>', is_dynamic: true}],
description: '<string>',
notes: '<string>'
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/automations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/automations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'query' => '<string>',
'query_type' => '<string>',
'date' => '2023-12-25',
'description' => '<string>',
'is_active' => true,
'notes' => '<string>',
'run_at' => 123,
'arguments' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'actions' => [
[
'name' => '<string>',
'sort_order' => 123,
'uuid' => '<string>',
'arguments' => [
[
'name' => '<string>',
'value' => '<string>',
'is_dynamic' => true
]
],
'description' => '<string>',
'notes' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/automations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"query_type\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"notes\": \"<string>\",\n \"run_at\": 123,\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"sort_order\": 123,\n \"uuid\": \"<string>\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"is_dynamic\": true\n }\n ],\n \"description\": \"<string>\",\n \"notes\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/automations")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"query_type\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"notes\": \"<string>\",\n \"run_at\": 123,\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"sort_order\": 123,\n \"uuid\": \"<string>\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"is_dynamic\": true\n }\n ],\n \"description\": \"<string>\",\n \"notes\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/automations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"query_type\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"notes\": \"<string>\",\n \"run_at\": 123,\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"sort_order\": 123,\n \"uuid\": \"<string>\",\n \"arguments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"is_dynamic\": true\n }\n ],\n \"description\": \"<string>\",\n \"notes\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"type": "<string>",
"query": "<string>",
"query_type": "<string>",
"date": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>"
}
],
"slot": "<string>",
"actions": [
{
"id": 123,
"uuid": "<string>",
"references_id": "<string>",
"name": "<string>",
"sort_order": 123,
"description": "<string>",
"notes": "<string>",
"arguments": [
{
"name": "<string>",
"value": "<string>",
"is_dynamic": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>"
}
],
"description": "<string>",
"notes": "<string>",
"is_active": true,
"frequency": "<string>",
"run_at": 123,
"last_run_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Available options:
date, scheduled Available options:
AU-MEL-0, AU-MEL-1, AU-MEL-2, AU-MEL-3, AU-MEL-4, AU-MEL-5, AU-MEL-6, AU-MEL-7, AU-MEL-8, AU-MEL-9, AU-MEL-10, AU-MEL-11, AU-MEL-12, AU-MEL-13, AU-MEL-14, AU-MEL-15, AU-MEL-16, AU-MEL-17, AU-MEL-18, AU-MEL-19, AU-MEL-20, AU-MEL-21, AU-MEL-22, AU-MEL-23, NZ-AUK-1, AU-MEL-HOURLY-0 Available options:
monthly, weekly, fortnightly, daily Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Response
Automation
Show child attributes
Show child attributes
⌘I