Create automation
curl --request POST \
--url https://{instance}/api/v1/automations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true,
"trigger": {
"filter": {}
},
"actions": [
{
"config": {},
"continueOnError": false
}
],
"description": "<string>",
"conditions": "<unknown>",
"maxRunsPerMinute": 5000,
"maxExternalActionsPerMinute": 5000,
"circuitBreakerThreshold": 50,
"circuitBreakerCooldownSeconds": 43215
}
'import requests
url = "https://{instance}/api/v1/automations"
payload = {
"name": "<string>",
"enabled": True,
"trigger": { "filter": {} },
"actions": [
{
"config": {},
"continueOnError": False
}
],
"description": "<string>",
"conditions": "<unknown>",
"maxRunsPerMinute": 5000,
"maxExternalActionsPerMinute": 5000,
"circuitBreakerThreshold": 50,
"circuitBreakerCooldownSeconds": 43215
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
enabled: true,
trigger: {filter: {}},
actions: [{config: {}, continueOnError: false}],
description: '<string>',
conditions: '<unknown>',
maxRunsPerMinute: 5000,
maxExternalActionsPerMinute: 5000,
circuitBreakerThreshold: 50,
circuitBreakerCooldownSeconds: 43215
})
};
fetch('https://{instance}/api/v1/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://{instance}/api/v1/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>',
'enabled' => true,
'trigger' => [
'filter' => [
]
],
'actions' => [
[
'config' => [
],
'continueOnError' => false
]
],
'description' => '<string>',
'conditions' => '<unknown>',
'maxRunsPerMinute' => 5000,
'maxExternalActionsPerMinute' => 5000,
'circuitBreakerThreshold' => 50,
'circuitBreakerCooldownSeconds' => 43215
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{instance}/api/v1/automations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"trigger\": {\n \"filter\": {}\n },\n \"actions\": [\n {\n \"config\": {},\n \"continueOnError\": false\n }\n ],\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"maxRunsPerMinute\": 5000,\n \"maxExternalActionsPerMinute\": 5000,\n \"circuitBreakerThreshold\": 50,\n \"circuitBreakerCooldownSeconds\": 43215\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{instance}/api/v1/automations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"trigger\": {\n \"filter\": {}\n },\n \"actions\": [\n {\n \"config\": {},\n \"continueOnError\": false\n }\n ],\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"maxRunsPerMinute\": 5000,\n \"maxExternalActionsPerMinute\": 5000,\n \"circuitBreakerThreshold\": 50,\n \"circuitBreakerCooldownSeconds\": 43215\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/v1/automations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"trigger\": {\n \"filter\": {}\n },\n \"actions\": [\n {\n \"config\": {},\n \"continueOnError\": false\n }\n ],\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"maxRunsPerMinute\": 5000,\n \"maxExternalActionsPerMinute\": 5000,\n \"circuitBreakerThreshold\": 50,\n \"circuitBreakerCooldownSeconds\": 43215\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"enabled": true,
"triggerEvent": "<string>",
"trigger": "<unknown>",
"conditions": "<unknown>",
"actions": "<unknown>",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"definitionVersion": 123,
"approvalRequestedAt": "<string>",
"approvedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approvedAt": "<string>",
"publishedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedAt": "<string>",
"maxRunsPerMinute": 123,
"maxExternalActionsPerMinute": 123,
"circuitBreakerThreshold": 123,
"circuitBreakerCooldownSeconds": 123,
"circuitOpenUntil": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"meta": {
"pagination": {
"nextCursor": "<string>",
"hasMore": true,
"limit": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Automations
Create automation
POST
/
api
/
v1
/
automations
Create automation
curl --request POST \
--url https://{instance}/api/v1/automations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true,
"trigger": {
"filter": {}
},
"actions": [
{
"config": {},
"continueOnError": false
}
],
"description": "<string>",
"conditions": "<unknown>",
"maxRunsPerMinute": 5000,
"maxExternalActionsPerMinute": 5000,
"circuitBreakerThreshold": 50,
"circuitBreakerCooldownSeconds": 43215
}
'import requests
url = "https://{instance}/api/v1/automations"
payload = {
"name": "<string>",
"enabled": True,
"trigger": { "filter": {} },
"actions": [
{
"config": {},
"continueOnError": False
}
],
"description": "<string>",
"conditions": "<unknown>",
"maxRunsPerMinute": 5000,
"maxExternalActionsPerMinute": 5000,
"circuitBreakerThreshold": 50,
"circuitBreakerCooldownSeconds": 43215
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
enabled: true,
trigger: {filter: {}},
actions: [{config: {}, continueOnError: false}],
description: '<string>',
conditions: '<unknown>',
maxRunsPerMinute: 5000,
maxExternalActionsPerMinute: 5000,
circuitBreakerThreshold: 50,
circuitBreakerCooldownSeconds: 43215
})
};
fetch('https://{instance}/api/v1/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://{instance}/api/v1/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>',
'enabled' => true,
'trigger' => [
'filter' => [
]
],
'actions' => [
[
'config' => [
],
'continueOnError' => false
]
],
'description' => '<string>',
'conditions' => '<unknown>',
'maxRunsPerMinute' => 5000,
'maxExternalActionsPerMinute' => 5000,
'circuitBreakerThreshold' => 50,
'circuitBreakerCooldownSeconds' => 43215
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{instance}/api/v1/automations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"trigger\": {\n \"filter\": {}\n },\n \"actions\": [\n {\n \"config\": {},\n \"continueOnError\": false\n }\n ],\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"maxRunsPerMinute\": 5000,\n \"maxExternalActionsPerMinute\": 5000,\n \"circuitBreakerThreshold\": 50,\n \"circuitBreakerCooldownSeconds\": 43215\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{instance}/api/v1/automations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"trigger\": {\n \"filter\": {}\n },\n \"actions\": [\n {\n \"config\": {},\n \"continueOnError\": false\n }\n ],\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"maxRunsPerMinute\": 5000,\n \"maxExternalActionsPerMinute\": 5000,\n \"circuitBreakerThreshold\": 50,\n \"circuitBreakerCooldownSeconds\": 43215\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/v1/automations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"trigger\": {\n \"filter\": {}\n },\n \"actions\": [\n {\n \"config\": {},\n \"continueOnError\": false\n }\n ],\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"maxRunsPerMinute\": 5000,\n \"maxExternalActionsPerMinute\": 5000,\n \"circuitBreakerThreshold\": 50,\n \"circuitBreakerCooldownSeconds\": 43215\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"enabled": true,
"triggerEvent": "<string>",
"trigger": "<unknown>",
"conditions": "<unknown>",
"actions": "<unknown>",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"definitionVersion": 123,
"approvalRequestedAt": "<string>",
"approvedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approvedAt": "<string>",
"publishedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publishedAt": "<string>",
"maxRunsPerMinute": 123,
"maxExternalActionsPerMinute": 123,
"circuitBreakerThreshold": 123,
"circuitBreakerCooldownSeconds": 123,
"circuitOpenUntil": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"meta": {
"pagination": {
"nextCursor": "<string>",
"hasMore": true,
"limit": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required string length:
1 - 120Show child attributes
Show child attributes
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Maximum string length:
2000Required range:
1 <= x <= 10000Required range:
1 <= x <= 10000Required range:
1 <= x <= 100Required range:
30 <= x <= 86400⌘I