Create a webhook

Requires EDITOR. URL must be http(s) (http only in dev/preview) and must not target private/loopback/link-local hosts (SSRF guard). Response reveals the plaintext secret once.

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

url

required

Http(s) URL; SSRF-validated

string

eventTypes

required

Array<string>

>= 1 items

active

boolean

Example^generated

1
{
2
  "name": "example",
3
  "url": "example",
4
  "eventTypes": [
5
    "example"
6
  ],
7
  "active": true
8
}

Responses

201

Created webhook (secret exposed).

application/json

object

webhook

Webhook with the plaintext signing secret exposed (create / regenerate only).

object

string

projectId

string

name

string

url

string

secret

Plaintext signing secret (shown once).

string

eventTypes

Array<string>

active

boolean

createdAt

string format: date-time

updatedAt

string format: date-time

400

Validation error or disallowed/insecure URL.

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
}

POST

/api/projects/{projectId}/webhooks

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/webhooks \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "url": "<string>",
8
  "eventTypes": [
9
    "<string>"
10
  ],
11
  "active": true
12
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/webhooks';
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>","url":"<string>","eventTypes":["<string>"],"active":true}'
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/webhooks"
4

5
payload = {
6
    "name": "<string>",
7
    "url": "<string>",
8
    "eventTypes": ["<string>"],
9
    "active": True
10
}
11
headers = {
12
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
13
    "Content-Type": "application/json"
14
}
15

16
response = requests.post(url, json=payload, headers=headers)
17

18
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"active\": true\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/webhooks"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"active\": true\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 webhook (secret exposed).

1
{
2
  "webhook": {
3
    "id": "example",
4
    "projectId": "example",
5
    "name": "example",
6
    "url": "example",
7
    "secret": "example",
8
    "eventTypes": [
9
      "example"
10
    ],
11
    "active": true,
12
    "createdAt": "2026-04-15T12:00:00Z",
13
    "updatedAt": "2026-04-15T12:00:00Z"
14
  }
15
}

Create a webhook

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

201

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated