Create an event definition (SUPER_ADMIN)

Authorizations

SessionCookie

Request Body^required

application/json

object

code

required

string

>= 1 characters

name

required

string

>= 1 characters

category

required

string

>= 1 characters

description

string | null

<= 500 characters

hasAmount

boolean

isSystem

boolean

sortOrder

integer

Example^generated

1
{
2
  "code": "example",
3
  "name": "example",
4
  "category": "example",
5
  "description": "example",
6
  "hasAmount": true,
7
  "isSystem": true,
8
  "sortOrder": 1
9
}

Responses

201

{ event }

application/json

object

key

additional properties

any

400

Invalid config

application/json

Validation error envelope (Zod). issues/details present on schema failures.

object

error

required

string

issues

Array<object>

object

key

additional properties

any

details

Array<object>

object

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "issues": [
4
    {}
5
  ],
6
  "details": [
7
    {}
8
  ]
9
}

409

Code already exists

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

POST

/api/admin/events

1
curl --request POST \
2
  --url https://retidal.com/api/admin/events \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "code": "<string>",
7
  "name": "<string>",
8
  "category": "<string>",
9
  "description": "<string>",
10
  "hasAmount": true,
11
  "isSystem": true,
12
  "sortOrder": 0
13
}'

1
const url = 'https://retidal.com/api/admin/events';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"code":"<string>","name":"<string>","category":"<string>","description":"<string>","hasAmount":true,"isSystem":true,"sortOrder":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/admin/events"
4

5
payload = {
6
    "code": "<string>",
7
    "name": "<string>",
8
    "category": "<string>",
9
    "description": "<string>",
10
    "hasAmount": True,
11
    "isSystem": True,
12
    "sortOrder": 0
13
}
14
headers = {
15
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
16
    "Content-Type": "application/json"
17
}
18

19
response = requests.post(url, json=payload, headers=headers)
20

21
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/admin/events"
5

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

8
payload = json.loads("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category\": \"<string>\",\n  \"description\": \"<string>\",\n  \"hasAmount\": true,\n  \"isSystem\": true,\n  \"sortOrder\": 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/admin/events"
13

14
  payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category\": \"<string>\",\n  \"description\": \"<string>\",\n  \"hasAmount\": true,\n  \"isSystem\": true,\n  \"sortOrder\": 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
}

201{ event }

1
{}

Create an event definition (SUPER_ADMIN)

Authorizations

Request Bodyrequired

Examplegenerated

Responses

201

400

Examplegenerated

409

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated