Create derived event rule

Requires ADMIN. Body validated by createDerivedRuleSchema (../../derived/validation). Guards: per-project count cap, anti-cycle (may not subscribe to a derived event), output-event-name uniqueness. See notes for schema uncertainty.

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

ruleType

required

string

Allowed values: event_condition absence

subjectType

required

string

Allowed values: identified_user account

subscribedEvents

required

Array<string>

condition

object | null

outputEventName

required

string

outputEventCategory

string

enabled

boolean

absenceThresholdSeconds

Used only when ruleType=absence. Omit when unused — null is rejected.

integer

>= 1

key

additional properties

any

Responses

201

Created rule.

application/json

object

rule

object

key

additional properties

any

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
}

409

Rule count cap reached (error=rule_limit_reached).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

422

Validation failed, cycle (error=subscribes_derived_event), or output-name conflict (error=output_event_name_conflict).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

POST

/api/projects/{projectId}/derived-rules

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/derived-rules \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "ruleType": "event_condition",
8
  "subjectType": "identified_user",
9
  "subscribedEvents": [
10
    "<string>"
11
  ],
12
  "condition": {},
13
  "outputEventName": "<string>",
14
  "outputEventCategory": "<string>",
15
  "enabled": true,
16
  "absenceThresholdSeconds": 0
17
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/derived-rules';
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>","ruleType":"event_condition","subjectType":"identified_user","subscribedEvents":["<string>"],"condition":{},"outputEventName":"<string>","outputEventCategory":"<string>","enabled":true,"absenceThresholdSeconds":0}'
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/derived-rules"
4

5
payload = {
6
    "name": "<string>",
7
    "ruleType": "event_condition",
8
    "subjectType": "identified_user",
9
    "subscribedEvents": ["<string>"],
10
    "condition": {},
11
    "outputEventName": "<string>",
12
    "outputEventCategory": "<string>",
13
    "enabled": True,
14
    "absenceThresholdSeconds": 0
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/derived-rules"
5

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"ruleType\": \"event_condition\",\n  \"subjectType\": \"identified_user\",\n  \"subscribedEvents\": [\n    \"<string>\"\n  ],\n  \"condition\": {},\n  \"outputEventName\": \"<string>\",\n  \"outputEventCategory\": \"<string>\",\n  \"enabled\": true,\n  \"absenceThresholdSeconds\": 0\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/derived-rules"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"ruleType\": \"event_condition\",\n  \"subjectType\": \"identified_user\",\n  \"subscribedEvents\": [\n    \"<string>\"\n  ],\n  \"condition\": {},\n  \"outputEventName\": \"<string>\",\n  \"outputEventCategory\": \"<string>\",\n  \"enabled\": true,\n  \"absenceThresholdSeconds\": 0\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 rule.

1
{
2
  "rule": {}
3
}

Create derived event rule

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

409

Examplegenerated

422

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated