[internal] Append a normalized email event

Worker-to-worker only (tracking Worker → foundation). Auth: x-worker-token == WORKER_INTERNAL_TOKEN. Idempotent on (providerKey, providerEventId). Not customer-facing.

Authorizations

WorkerToken

Request Body^required

application/json

object

projectId

required

string

normalizedType

required

string

Allowed values: delivered opened clicked bounced complained unsubscribed dropped deferred failed

providerEventId

required

string

occurredAt

required

string format: date-time

providerId

string

providerKey

string

default: tracking

providerEventType

string

recipient

string

bounceType

string

diagnosticCode

string

linkUrl

string

raw

object

key

additional properties

any

messageRef

object

providerMessageId

string

trackingId

string

Responses

200

Persisted (inserted flag).

application/json

object

boolean

inserted

boolean

400

Invalid JSON or missing/invalid required field.

application/json

object

boolean

error

string

Example^generated

1
{
2
  "ok": true,
3
  "error": "example"
4
}

401

Missing/incorrect x-worker-token.

application/json

object

boolean

error

string

Example^generated

1
{
2
  "ok": true,
3
  "error": "example"
4
}

500

Persistence error.

application/json

object

boolean

error

string

Example^generated

1
{
2
  "ok": true,
3
  "error": "example"
4
}

POST

/api/internal/email/events/append

1
curl --request POST \
2
  --url https://retidal.com/api/internal/email/events/append \
3
  --header 'Content-Type: application/json' \
4
  --header 'x-worker-token: <YOUR_API_KEY>' \
5
  --data '{
6
  "projectId": "<string>",
7
  "normalizedType": "delivered",
8
  "providerEventId": "<string>",
9
  "occurredAt": "<string>",
10
  "providerId": "<string>",
11
  "providerKey": "tracking",
12
  "providerEventType": "<string>",
13
  "recipient": "<string>",
14
  "bounceType": "<string>",
15
  "diagnosticCode": "<string>",
16
  "linkUrl": "<string>",
17
  "raw": {},
18
  "messageRef": {
19
    "providerMessageId": "<string>",
20
    "trackingId": "<string>"
21
  }
22
}'

1
const url = 'https://retidal.com/api/internal/email/events/append';
2
const options = {
3
  method: 'POST',
4
  headers: {'x-worker-token': '<YOUR_API_KEY>', 'Content-Type': 'application/json'},
5
  body: '{"projectId":"<string>","normalizedType":"delivered","providerEventId":"<string>","occurredAt":"<string>","providerId":"<string>","providerKey":"tracking","providerEventType":"<string>","recipient":"<string>","bounceType":"<string>","diagnosticCode":"<string>","linkUrl":"<string>","raw":{},"messageRef":{"providerMessageId":"<string>","trackingId":"<string>"}}'
6
};
7

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

1
import requests
2

3
url = "https://retidal.com/api/internal/email/events/append"
4

5
payload = {
6
    "projectId": "<string>",
7
    "normalizedType": "delivered",
8
    "providerEventId": "<string>",
9
    "occurredAt": "<string>",
10
    "providerId": "<string>",
11
    "providerKey": "tracking",
12
    "providerEventType": "<string>",
13
    "recipient": "<string>",
14
    "bounceType": "<string>",
15
    "diagnosticCode": "<string>",
16
    "linkUrl": "<string>",
17
    "raw": {},
18
    "messageRef": {
19
        "providerMessageId": "<string>",
20
        "trackingId": "<string>"
21
    }
22
}
23
headers = {
24
    "x-worker-token": "<YOUR_API_KEY>",
25
    "Content-Type": "application/json"
26
}
27

28
response = requests.post(url, json=payload, headers=headers)
29

30
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/internal/email/events/append"
5

6
headers = {"x-worker-token": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"projectId\": \"<string>\",\n  \"normalizedType\": \"delivered\",\n  \"providerEventId\": \"<string>\",\n  \"occurredAt\": \"<string>\",\n  \"providerId\": \"<string>\",\n  \"providerKey\": \"tracking\",\n  \"providerEventType\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"bounceType\": \"<string>\",\n  \"diagnosticCode\": \"<string>\",\n  \"linkUrl\": \"<string>\",\n  \"raw\": {},\n  \"messageRef\": {\n    \"providerMessageId\": \"<string>\",\n    \"trackingId\": \"<string>\"\n  }\n}")
9

10
response = httpx.post(url, headers=headers, 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/internal/email/events/append"
13

14
  payload := strings.NewReader("{\n  \"projectId\": \"<string>\",\n  \"normalizedType\": \"delivered\",\n  \"providerEventId\": \"<string>\",\n  \"occurredAt\": \"<string>\",\n  \"providerId\": \"<string>\",\n  \"providerKey\": \"tracking\",\n  \"providerEventType\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"bounceType\": \"<string>\",\n  \"diagnosticCode\": \"<string>\",\n  \"linkUrl\": \"<string>\",\n  \"raw\": {},\n  \"messageRef\": {\n    \"providerMessageId\": \"<string>\",\n    \"trackingId\": \"<string>\"\n  }\n}")
15

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

18
  req.Header.Add("x-worker-token", "<YOUR_API_KEY>")
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
}

200Persisted (inserted flag).

1
{
2
  "ok": true,
3
  "inserted": true
4
}

[internal] Append a normalized email event

Authorizations

Request Bodyrequired

Responses

200

400

Examplegenerated

401

Examplegenerated

500

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated