Skip to content

feat(tem): add fields #3933

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 4, 2024
Merged

feat(tem): add fields #3933

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52d4ab7
fix(tem): 1st draft
ldecarvalho-doc Nov 4, 2024
f65dd1d
fix(tem): code
ldecarvalho-doc Nov 4, 2024
36a88ff
fix(tem): add desc
ldecarvalho-doc Nov 4, 2024
e72520e
fix(tem): review jj
ldecarvalho-doc Nov 4, 2024
ae6d9e2
fix(tem): review jj 2
ldecarvalho-doc Nov 4, 2024
4994dbc
fix(tem): switch name for key
ldecarvalho-doc Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 68 additions & 55 deletions managed-services/transactional-email/api-cli/webhook-events-payloads.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ Find below a detailed description of the fields in a [Webhoook event](/managed-s
| `email_from` | Email FROM address |
| `email_to` | Email recipient address |
| `email_headers` | SMTP headers |
| `email_error` | SMTP message explaining the drop |
| `email_error` | **DEPRECATED** SMTP message explaining the drop |
| `email_next_try` | Next time the email will be sent to the recipient server |
| `email_try_count` | Total number of tries attempted for this email |
| `email_response_code` | SMTP response code |
| `email_response_message` | SMTP response message |


## Examples of payload by event type
Expand All @@ -45,20 +47,20 @@ Webhooks may trigger different [types of events](/managed-services/transactional
## email_queued
```json
{
"id": string,
"id": UUID,
"type": "email_queued",
"organization_id": string,
"project_id": string,
"domain_id": string,
"organization_id": UUID,
"project_id": UUID,
"domain_id": UUID,
"domain_name": string,
"created_at": date,
"email_queued_at": date,
"email_id": string,
"created_at": time,
"email_queued_at": timed,
"email_id": UUID,
"email_from": string,
"email_to": string,
"email_headers": [
{
"name": string,
"key": string,
"value": string
}
]
Expand All @@ -67,115 +69,126 @@ Webhooks may trigger different [types of events](/managed-services/transactional
## email_dropped
```json
{
"id": string,
{
"id": UUID,
"type": "email_dropped",
"organization_id": string,
"project_id": string,
"domain_id": string,
"organization_id": UUID,
"project_id": UUID,
"domain_id": UUID,
"domain_name": string,
"created_at": date,
"email_sent_at": date,
"email_id": string,
"created_at": time,
"email_sent_at": time,
"email_id": UUID,
"email_from": string,
"email_to": string,
"email_headers": [
{
"name": string,
"key": string,
"value": string
}
],
"email_sent_at": time,
"email_error": string,
}
"email_response_code": int,
"email_response_message": string
```
## email_delivered
```json
{
"id": string,
"id": UUID,
"type": "email_delivered",
"organization_id": string,
"project_id": string,
"domain_id": string,
"organization_id": UUID,
"project_id": UUID,
"domain_id": UUID,
"domain_name": string,
"created_at": date,
"email_sent_at": date,
"email_id": string,
"created_at": time,
"email_sent_at": time,
"email_id": UUID,
"email_from": string,
"email_to": string,
"email_headers": [
{
"name": string,
"key": string,
"value": string
}
]
],
"email_response_code": int,
"email_response_message": string
}
```
## email_mailbox_not_found
```json
{
"id": string,
"id": UUID,
"type": "email_mailbox_not_found",
"organization_id": string,
"project_id": string,
"domain_id": string,
"organization_id": UUID,
"project_id": UUID,
"domain_id": UUID,
"domain_name": string,
"created_at": date,
"email_sent_at": date,
"email_id": string,
"created_at": time,
"email_sent_at": time,
"email_id": UUID,
"email_from": string,
"email_to": string,
"email_headers": [
{
"name": string,
"key": string,
"value": string
}
]
],
"email_response_code": int,
"email_response_message": string
}
```
## email_spam
```json
{
"id": string,
"id": UUID,
"type": "email_spam",
"organization_id": string,
"project_id": string,
"domain_id": string,
"organization_id": UUID,
"project_id": UUID,
"domain_id": UUID,
"domain_name": string,
"created_at": date,
"email_sent_at": date,
"email_id": string,
"created_at": time,
"email_sent_at": time,
"email_id": UUID,
"email_from": string,
"email_to": string,
"email_headers": [
{
"name": string,
"key": string,
"value": string
}
]
],
"email_response_code": int,
"email_response_message": string
}
```
## email_deferred
```json
{
"id": string,
"id": UUID,
"type": "email_deferred",
"organization_id": string,
"project_id": string,
"domain_id": string,
"organization_id": UUID,
"project_id": UUID,
"domain_id": UUID,
"domain_name": string,
"created_at": date,
"email_sent_at": date,
"email_id": string,
"created_at": time,
"email_sent_at": time,
"email_id": UUID,
"email_from": string,
"email_to": string,
"email_headers": [
{
"name": string,
"key": string,
"value": string
}
],
"email_error": string,
"email_next_try": date,
"email_try_count": integer
"email_next_try": time,
"email_try_count": int,
"email_response_code": int,
"email_response_message": string
}
```