Create an event trigger

Requires EDITOR. templateId/providerId/identityId must belong to the project. match supports properties, conditionTree, and userFilter. Guardrails cover rate window, quiet hours, and dedupe window.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Tenant project id (row-level isolation on every query).

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

eventName

required

string

>= 1 characters <= 200 characters

match

Trigger match rule. properties (event props), conditionTree (2-level any/all fact rules), userFilter (segment).

object

properties

object

key

additional properties

any

conditionTree

object | null

userFilter

Segment predicate shared by campaigns and trigger userFilter (all fields optional).

object

locale

One of:

string
Array<string>

string

hasEmail

boolean

hasPhone

boolean

userIdLike

string

firstSeenFrom

string format: date-time

firstSeenTo

string format: date-time

lastSeenFrom

string format: date-time

lastSeenTo

string format: date-time

savedAudienceId

string

queueKey

string

Allowed values: new_paid_activation key_created_low_usage high_balance_inactive high_value low_balance_renewal churn_risk_paid

paidStatus

One of:

string
Array<string>

string

valueTier

One of:

string
Array<string>

string

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string format: date-time

lastPurchaseTo

string format: date-time

lifecycleStage

One of:

string
Array<string>

string

recommendedAction

One of:

string
Array<string>

string

templateId

required

string

>= 1 characters

providerId

string | null

>= 1 characters

identityId

string | null

>= 1 characters

category

string

default: transactional

Allowed values: transactional marketing

enabled

boolean

default: true

maxSendsPerWindow

integer | null

>= 1 <= 100000

windowSeconds

integer

default: 86400 >= 1 <= 31536000

quietHoursStartHour

integer | null

<= 23

quietHoursEndHour

integer | null

<= 23

quietHoursMode

string

default: defer

Allowed values: defer drop

dedupeWindowSeconds

integer

default: 3600 <= 31536000

dynamicAttachments

Array<object>

default: <= 3 items

object

fromProperty

required

Event property holding the attachment URL.

string

>= 1 characters <= 120 characters

filename

string

>= 1 characters <= 200 characters

Responses

201

Created trigger.

application/json

object

trigger

object

string

name

string

eventName

string

match

Trigger match rule. properties (event props), conditionTree (2-level any/all fact rules), userFilter (segment).

object

properties

object

key

additional properties

any

conditionTree

object | null

userFilter

Segment predicate shared by campaigns and trigger userFilter (all fields optional).

object

locale

One of:

string
Array<string>

string

hasEmail

boolean

hasPhone

boolean

userIdLike

string

firstSeenFrom

string format: date-time

firstSeenTo

string format: date-time

lastSeenFrom

string format: date-time

lastSeenTo

string format: date-time

savedAudienceId

string

queueKey

string

Allowed values: new_paid_activation key_created_low_usage high_balance_inactive high_value low_balance_renewal churn_risk_paid

paidStatus

One of:

string
Array<string>

string

valueTier

One of:

string
Array<string>

string

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string format: date-time

lastPurchaseTo

string format: date-time

lifecycleStage

One of:

string
Array<string>

string

recommendedAction

One of:

string
Array<string>

string

templateId

string

providerId

string | null

identityId

string | null

category

string

Allowed values: transactional marketing

enabled

boolean

guardrails

object

maxSendsPerWindow

integer | null

windowSeconds

integer

quietHoursStartHour

integer | null

quietHoursEndHour

integer | null

quietHoursMode

string

Allowed values: defer drop

dedupeWindowSeconds

integer

dynamicAttachments

Array<object>

object

fromProperty

required

Event property holding the attachment URL.

string

>= 1 characters <= 120 characters

filename

string

>= 1 characters <= 200 characters

createdAt

string | null format: date-time

updatedAt

string | null format: date-time

400

Validation error, or identity/channel mismatch.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

401

Not authenticated (no valid session/principal).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

403

Authenticated but lacks the required project role.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

404

Resource not found (or belongs to another project — indistinguishable).

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}/email/triggers

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/email/triggers \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "eventName": "<string>",
8
  "match": {
9
    "properties": {},
10
    "conditionTree": {},
11
    "userFilter": {
12
      "locale": "<string>",
13
      "hasEmail": true,
14
      "hasPhone": true,
15
      "userIdLike": "<string>",
16
      "firstSeenFrom": "<string>",
17
      "firstSeenTo": "<string>",
18
      "lastSeenFrom": "<string>",
19
      "lastSeenTo": "<string>",
20
      "savedAudienceId": "<string>",
21
      "queueKey": "new_paid_activation",
22
      "paidStatus": "<string>",
23
      "valueTier": "<string>",
24
      "minLtv": 0,
25
      "maxLtv": 0,
26
      "minBalance": 0,
27
      "maxBalance": 0,
28
      "minUsage30d": 0,
29
      "maxUsage30d": 0,
30
      "lastPurchaseFrom": "<string>",
31
      "lastPurchaseTo": "<string>",
32
      "lifecycleStage": "<string>",
33
      "recommendedAction": "<string>"
34
    }
35
  },
36
  "templateId": "<string>",
37
  "providerId": "<string>",
38
  "identityId": "<string>",
39
  "category": "transactional",
40
  "enabled": true,
41
  "maxSendsPerWindow": 0,
42
  "windowSeconds": 86400,
43
  "quietHoursStartHour": 0,
44
  "quietHoursEndHour": 0,
45
  "quietHoursMode": "defer",
46
  "dedupeWindowSeconds": 3600,
47
  "dynamicAttachments": []
48
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/triggers';
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>","eventName":"<string>","match":{"properties":{},"conditionTree":{},"userFilter":{"locale":"<string>","hasEmail":true,"hasPhone":true,"userIdLike":"<string>","firstSeenFrom":"<string>","firstSeenTo":"<string>","lastSeenFrom":"<string>","lastSeenTo":"<string>","savedAudienceId":"<string>","queueKey":"new_paid_activation","paidStatus":"<string>","valueTier":"<string>","minLtv":0,"maxLtv":0,"minBalance":0,"maxBalance":0,"minUsage30d":0,"maxUsage30d":0,"lastPurchaseFrom":"<string>","lastPurchaseTo":"<string>","lifecycleStage":"<string>","recommendedAction":"<string>"}},"templateId":"<string>","providerId":"<string>","identityId":"<string>","category":"transactional","enabled":true,"maxSendsPerWindow":0,"windowSeconds":86400,"quietHoursStartHour":0,"quietHoursEndHour":0,"quietHoursMode":"defer","dedupeWindowSeconds":3600,"dynamicAttachments":[]}'
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/email/triggers"
4

5
payload = {
6
    "name": "<string>",
7
    "eventName": "<string>",
8
    "match": {
9
        "properties": {},
10
        "conditionTree": {},
11
        "userFilter": {
12
            "locale": "<string>",
13
            "hasEmail": True,
14
            "hasPhone": True,
15
            "userIdLike": "<string>",
16
            "firstSeenFrom": "<string>",
17
            "firstSeenTo": "<string>",
18
            "lastSeenFrom": "<string>",
19
            "lastSeenTo": "<string>",
20
            "savedAudienceId": "<string>",
21
            "queueKey": "new_paid_activation",
22
            "paidStatus": "<string>",
23
            "valueTier": "<string>",
24
            "minLtv": 0,
25
            "maxLtv": 0,
26
            "minBalance": 0,
27
            "maxBalance": 0,
28
            "minUsage30d": 0,
29
            "maxUsage30d": 0,
30
            "lastPurchaseFrom": "<string>",
31
            "lastPurchaseTo": "<string>",
32
            "lifecycleStage": "<string>",
33
            "recommendedAction": "<string>"
34
        }
35
    },
36
    "templateId": "<string>",
37
    "providerId": "<string>",
38
    "identityId": "<string>",
39
    "category": "transactional",
40
    "enabled": True,
41
    "maxSendsPerWindow": 0,
42
    "windowSeconds": 86400,
43
    "quietHoursStartHour": 0,
44
    "quietHoursEndHour": 0,
45
    "quietHoursMode": "defer",
46
    "dedupeWindowSeconds": 3600,
47
    "dynamicAttachments": []
48
}
49
headers = {
50
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
51
    "Content-Type": "application/json"
52
}
53

54
response = requests.post(url, json=payload, headers=headers)
55

56
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"eventName\": \"<string>\",\n  \"match\": {\n    \"properties\": {},\n    \"conditionTree\": {},\n    \"userFilter\": {\n      \"locale\": \"<string>\",\n      \"hasEmail\": true,\n      \"hasPhone\": true,\n      \"userIdLike\": \"<string>\",\n      \"firstSeenFrom\": \"<string>\",\n      \"firstSeenTo\": \"<string>\",\n      \"lastSeenFrom\": \"<string>\",\n      \"lastSeenTo\": \"<string>\",\n      \"savedAudienceId\": \"<string>\",\n      \"queueKey\": \"new_paid_activation\",\n      \"paidStatus\": \"<string>\",\n      \"valueTier\": \"<string>\",\n      \"minLtv\": 0,\n      \"maxLtv\": 0,\n      \"minBalance\": 0,\n      \"maxBalance\": 0,\n      \"minUsage30d\": 0,\n      \"maxUsage30d\": 0,\n      \"lastPurchaseFrom\": \"<string>\",\n      \"lastPurchaseTo\": \"<string>\",\n      \"lifecycleStage\": \"<string>\",\n      \"recommendedAction\": \"<string>\"\n    }\n  },\n  \"templateId\": \"<string>\",\n  \"providerId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"category\": \"transactional\",\n  \"enabled\": true,\n  \"maxSendsPerWindow\": 0,\n  \"windowSeconds\": 86400,\n  \"quietHoursStartHour\": 0,\n  \"quietHoursEndHour\": 0,\n  \"quietHoursMode\": \"defer\",\n  \"dedupeWindowSeconds\": 3600,\n  \"dynamicAttachments\": []\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/email/triggers"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"eventName\": \"<string>\",\n  \"match\": {\n    \"properties\": {},\n    \"conditionTree\": {},\n    \"userFilter\": {\n      \"locale\": \"<string>\",\n      \"hasEmail\": true,\n      \"hasPhone\": true,\n      \"userIdLike\": \"<string>\",\n      \"firstSeenFrom\": \"<string>\",\n      \"firstSeenTo\": \"<string>\",\n      \"lastSeenFrom\": \"<string>\",\n      \"lastSeenTo\": \"<string>\",\n      \"savedAudienceId\": \"<string>\",\n      \"queueKey\": \"new_paid_activation\",\n      \"paidStatus\": \"<string>\",\n      \"valueTier\": \"<string>\",\n      \"minLtv\": 0,\n      \"maxLtv\": 0,\n      \"minBalance\": 0,\n      \"maxBalance\": 0,\n      \"minUsage30d\": 0,\n      \"maxUsage30d\": 0,\n      \"lastPurchaseFrom\": \"<string>\",\n      \"lastPurchaseTo\": \"<string>\",\n      \"lifecycleStage\": \"<string>\",\n      \"recommendedAction\": \"<string>\"\n    }\n  },\n  \"templateId\": \"<string>\",\n  \"providerId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"category\": \"transactional\",\n  \"enabled\": true,\n  \"maxSendsPerWindow\": 0,\n  \"windowSeconds\": 86400,\n  \"quietHoursStartHour\": 0,\n  \"quietHoursEndHour\": 0,\n  \"quietHoursMode\": \"defer\",\n  \"dedupeWindowSeconds\": 3600,\n  \"dynamicAttachments\": []\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 trigger.

1
{
2
  "trigger": {
3
    "match": {
4
      "userFilter": {
5
        "queueKey": "new_paid_activation"
6
      }
7
    },
8
    "category": "transactional",
9
    "guardrails": {
10
      "quietHoursMode": "defer"
11
    }
12
  }
13
}

Create an event trigger

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated