Create automation (definition + trigger + entry/exit) in one request

Requires ADMIN project role. Validates graph + effect props before writing.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

description

string | null

<= 500 characters

triggerEventName

required

string

>= 1 characters <= 120 characters

entryConditionJson

object | null

exitConditionJson

object | null

reEntryMode

string

default: once

Allowed values: once every_rematch interval

reEntryIntervalSeconds

Required when reEntryMode=interval.

integer

>= 1

maxConcurrentPerUser

integer

default: 1 >= 1

definition

required

Journey/automation graph definition. Nodes are typed (trigger/action/branch/wait/waitForEvent/timeWindow).

object

nodes

required

Array<object>

>= 1 items

object

key

additional properties

any

key

additional properties

any

Responses

201

Created automation (status=draft) plus version=1 and field warnings.

application/json

object

automation

A journey row surfaced as an automation.

object

string

projectId

string

name

string

description

string | null

triggerEventName

string

maxConcurrentPerUser

integer

status

string

activeVersionId

string | null

entryConditionJson

string | null

reEntryMode

string

Allowed values: once every_rematch interval

reEntryIntervalSeconds

integer | null

exitConditionJson

string | null

createdAt

string

updatedAt

string

key

additional properties

any

version

integer

warnings

Array<string>

400

Missing/invalid path input (e.g. projectId) or invalid JSON body.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

422

Zod validation or definition/graph validation failed.

application/json

object

error

required

string

message

string

errors

Array<string>

issues

Array<object>

object

key

additional properties

any

draftId

string

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "message": "example",
4
  "errors": [
5
    "example"
6
  ],
7
  "issues": [
8
    {}
9
  ],
10
  "draftId": "example"
11
}

POST

/api/projects/{projectId}/automations

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/automations \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "description": "<string>",
8
  "triggerEventName": "<string>",
9
  "entryConditionJson": {},
10
  "exitConditionJson": {},
11
  "reEntryMode": "once",
12
  "reEntryIntervalSeconds": 0,
13
  "maxConcurrentPerUser": 1,
14
  "definition": {
15
    "nodes": [
16
      {}
17
    ]
18
  }
19
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/automations';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","description":"<string>","triggerEventName":"<string>","entryConditionJson":{},"exitConditionJson":{},"reEntryMode":"once","reEntryIntervalSeconds":0,"maxConcurrentPerUser":1,"definition":{"nodes":[{}]}}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/automations"
4

5
payload = {
6
    "name": "<string>",
7
    "description": "<string>",
8
    "triggerEventName": "<string>",
9
    "entryConditionJson": {},
10
    "exitConditionJson": {},
11
    "reEntryMode": "once",
12
    "reEntryIntervalSeconds": 0,
13
    "maxConcurrentPerUser": 1,
14
    "definition": { "nodes": [{}] }
15
}
16
headers = {
17
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
18
    "Content-Type": "application/json"
19
}
20

21
response = requests.post(url, json=payload, headers=headers)
22

23
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/automations"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"triggerEventName\": \"<string>\",\n  \"entryConditionJson\": {},\n  \"exitConditionJson\": {},\n  \"reEntryMode\": \"once\",\n  \"reEntryIntervalSeconds\": 0,\n  \"maxConcurrentPerUser\": 1,\n  \"definition\": {\n    \"nodes\": [\n      {}\n    ]\n  }\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/automations"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"triggerEventName\": \"<string>\",\n  \"entryConditionJson\": {},\n  \"exitConditionJson\": {},\n  \"reEntryMode\": \"once\",\n  \"reEntryIntervalSeconds\": 0,\n  \"maxConcurrentPerUser\": 1,\n  \"definition\": {\n    \"nodes\": [\n      {}\n    ]\n  }\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Created automation (status=draft) plus version=1 and field warnings.

1
{
2
  "automation": {
3
    "status": "draft",
4
    "reEntryMode": "once"
5
  },
6
  "version": 1
7
}

Create automation (definition + trigger + entry/exit) in one request

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

422

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated