Skip to content

Commit 7a5319b

Browse files
ldecarvalho-docldecarvalho-doc
authored
feat(tem): add fields (#3933)
1 parent 346b276 commit 7a5319b

File tree

1 file changed

+68
-55
lines changed

1 file changed

+68
-55
lines changed

‎managed-services/transactional-email/api-cli/webhook-events-payloads.mdx‎

Lines changed: 68 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ Find below a detailed description of the fields in a [Webhoook event](/managed-s
3333
| `email_from` | Email FROM address |
3434
| `email_to` | Email recipient address |
3535
| `email_headers` | SMTP headers |
36-
| `email_error` | SMTP message explaining the drop |
36+
| `email_error` | **DEPRECATED** SMTP message explaining the drop |
3737
| `email_next_try` | Next time the email will be sent to the recipient server |
3838
| `email_try_count` | Total number of tries attempted for this email |
39+
| `email_response_code` | SMTP response code |
40+
| `email_response_message` | SMTP response message |
3941

4042

4143
## Examples of payload by event type
@@ -45,20 +47,20 @@ Webhooks may trigger different [types of events](/managed-services/transactional
4547
## email_queued
4648
```json
4749
{
48-
"id": string,
50+
"id": UUID,
4951
"type": "email_queued",
50-
"organization_id": string,
51-
"project_id": string,
52-
"domain_id": string,
52+
"organization_id": UUID,
53+
"project_id": UUID,
54+
"domain_id": UUID,
5355
"domain_name": string,
54-
"created_at": date,
55-
"email_queued_at": date,
56-
"email_id": string,
56+
"created_at": time,
57+
"email_queued_at": timed,
58+
"email_id": UUID,
5759
"email_from": string,
5860
"email_to": string,
5961
"email_headers": [
6062
{
61-
"name": string,
63+
"key": string,
6264
"value": string
6365
}
6466
]
@@ -67,115 +69,126 @@ Webhooks may trigger different [types of events](/managed-services/transactional
6769
## email_dropped
6870
```json
6971
{
70-
"id": string,
72+
{
73+
"id": UUID,
7174
"type": "email_dropped",
72-
"organization_id": string,
73-
"project_id": string,
74-
"domain_id": string,
75+
"organization_id": UUID,
76+
"project_id": UUID,
77+
"domain_id": UUID,
7578
"domain_name": string,
76-
"created_at": date,
77-
"email_sent_at": date,
78-
"email_id": string,
79+
"created_at": time,
80+
"email_sent_at": time,
81+
"email_id": UUID,
7982
"email_from": string,
8083
"email_to": string,
8184
"email_headers": [
8285
{
83-
"name": string,
86+
"key": string,
8487
"value": string
8588
}
8689
],
90+
"email_sent_at": time,
8791
"email_error": string,
88-
}
92+
"email_response_code": int,
93+
"email_response_message": string
8994
```
9095
## email_delivered
9196
```json
9297
{
93-
"id": string,
98+
"id": UUID,
9499
"type": "email_delivered",
95-
"organization_id": string,
96-
"project_id": string,
97-
"domain_id": string,
100+
"organization_id": UUID,
101+
"project_id": UUID,
102+
"domain_id": UUID,
98103
"domain_name": string,
99-
"created_at": date,
100-
"email_sent_at": date,
101-
"email_id": string,
104+
"created_at": time,
105+
"email_sent_at": time,
106+
"email_id": UUID,
102107
"email_from": string,
103108
"email_to": string,
104109
"email_headers": [
105110
{
106-
"name": string,
111+
"key": string,
107112
"value": string
108113
}
109-
]
114+
],
115+
"email_response_code": int,
116+
"email_response_message": string
110117
}
111118
```
112119
## email_mailbox_not_found
113120
```json
114121
{
115-
"id": string,
122+
"id": UUID,
116123
"type": "email_mailbox_not_found",
117-
"organization_id": string,
118-
"project_id": string,
119-
"domain_id": string,
124+
"organization_id": UUID,
125+
"project_id": UUID,
126+
"domain_id": UUID,
120127
"domain_name": string,
121-
"created_at": date,
122-
"email_sent_at": date,
123-
"email_id": string,
128+
"created_at": time,
129+
"email_sent_at": time,
130+
"email_id": UUID,
124131
"email_from": string,
125132
"email_to": string,
126133
"email_headers": [
127134
{
128-
"name": string,
135+
"key": string,
129136
"value": string
130137
}
131-
]
138+
],
139+
"email_response_code": int,
140+
"email_response_message": string
132141
}
133142
```
134143
## email_spam
135144
```json
136145
{
137-
"id": string,
146+
"id": UUID,
138147
"type": "email_spam",
139-
"organization_id": string,
140-
"project_id": string,
141-
"domain_id": string,
148+
"organization_id": UUID,
149+
"project_id": UUID,
150+
"domain_id": UUID,
142151
"domain_name": string,
143-
"created_at": date,
144-
"email_sent_at": date,
145-
"email_id": string,
152+
"created_at": time,
153+
"email_sent_at": time,
154+
"email_id": UUID,
146155
"email_from": string,
147156
"email_to": string,
148157
"email_headers": [
149158
{
150-
"name": string,
159+
"key": string,
151160
"value": string
152161
}
153-
]
162+
],
163+
"email_response_code": int,
164+
"email_response_message": string
154165
}
155166
```
156167
## email_deferred
157168
```json
158169
{
159-
"id": string,
170+
"id": UUID,
160171
"type": "email_deferred",
161-
"organization_id": string,
162-
"project_id": string,
163-
"domain_id": string,
172+
"organization_id": UUID,
173+
"project_id": UUID,
174+
"domain_id": UUID,
164175
"domain_name": string,
165-
"created_at": date,
166-
"email_sent_at": date,
167-
"email_id": string,
176+
"created_at": time,
177+
"email_sent_at": time,
178+
"email_id": UUID,
168179
"email_from": string,
169180
"email_to": string,
170181
"email_headers": [
171182
{
172-
"name": string,
183+
"key": string,
173184
"value": string
174185
}
175186
],
176187
"email_error": string,
177-
"email_next_try": date,
178-
"email_try_count": integer
188+
"email_next_try": time,
189+
"email_try_count": int,
190+
"email_response_code": int,
191+
"email_response_message": string
179192
}
180193
```
181194

0 commit comments

Comments
 (0)