docs(tem): payload

scaleway · Sep 20, 2024 · ef2500d · ef2500d
1 parent e26f511
commit ef2500d
Showing 1 changed file with 151 additions and 0 deletions.
diff --git a/managed-services/transactional-email/api-cli/webhook-events-payload.mdx b/managed-services/transactional-email/api-cli/webhook-events-payload.mdx
@@ -0,0 +1,151 @@
+---
+meta:
+  title: Understanding Webhook event payloads
+  description: This page details the fields of the webhook event payloads for Scaleway Transactional Email
+content:
+  h1: Understanding Webhook event payloads
+  paragraph: This page details the fields of the webhook event payloads for Scaleway Transactional Email
+tags: spf spf-record dkim dkim-records dmarc dmarc-record transactional
+dates:
+  validation: 2024-09-20
+  posted: 2024-09-20
+categories:
+  - managed-services
+---
+
+Events triggered by webhooks contain payloads that describe and detail the events.
+
+Find below a detailed description of the fields in a [Webhoook event](/managed-services/transactional-email/how-to/create-webhooks/) payload.
+
+
+| Tag     | Description    |
+|---------|-------------------------------------|
+| `id`     | Event identifier                                                                          |
+| `type`     | Event type                                      |
+| `organization_id`    | Domain Organization                            |
+| `project_id` | Domain Project                                                       |
+| `domain_id`  | Domain identifier                                                       |
+| `domain_name`   | Domain name  |
+| `created_at`    | Event creation date                            |
+| `email_sent_at`    | 	Email reception date by the recipient server                          |
+| `email_queued_at` | Email reception date in by TEM proxy or API                                                          |
+| `email_id`  | Email identifier (used for GetEmail endpoint)                                                      |
+| `email_from`   | Email FROM address |
+| `email_to`  | Email recipient address                                                          |
+| `email_headers`   | SMTP headers  |
+| `email_error`   | SMTP message explaining the drop  |
+| `email_next_try`   | Next time we will try to send the email to the recipient server  |
+| `email_try_count`   | Total number of tries attempted for this email  |
+
+
+## Examples of payload by event type
+
+Webhooks may trigger different [types of events](/managed-services/transactional-email/concepts/#webhook-event-type). These types have varying payload fields.
+
+## email_queued
+```json
+{
+	"id": string,
+	"type": "email_queued",
+ 	"organization_id": string,
+	"project_id": string,
+    "domain_id": string,
+	"domain_name": string,
+    "created_at": string,
+	"email_queued_at": date,
+    "email_id": string,
+    "email_from": string,
+	"email_to": string,
+	"email_headers": [{"name": string, "value": string}],
+}
+```
+## email_dropped
+```json
+{
+	"id": string,
+	"type": "email_dropped",
+	"organization_id": string,
+	"project_id": string,
+    "domain_id": string,
+	"domain_name": string,
+    "created_at": string,
+	"email_sent_at": date,
+    "email_id": string,
+    "email_from": string,
+	"email_to": string,
+	"email_headers": [{"name": string, "value": string}],
+	"email_error": string,
+}
+```
+## email_delivered
+```json
+{
+	"id": string,
+	"type": "email_delivered",
+ 	"organization_id": string,
+	"project_id": string
+    "domain_id": string,
+	"domain_name": string,
+    "created_at": string,
+	"email_sent_at": date,
+    "email_id": string,
+    "email_from": string,
+	"email_to": string,
+	"email_headers": [{"name": string, "value": string}],
+}
+```
+## email_mailbox_not_found
+```json
+{
+	"id": string,
+	"type": "email_mailbox_not_found",
+ 	"organization_id": string,
+	"project_id": string,
+    "domain_id": string,
+	"domain_name": string,
+    "created_at": string,
+	"email_sent_at": date,
+    "email_id": string,
+    "email_from": string,
+	"email_to": string,
+	"email_headers": [{"name": string, "value": string}],
+}
+```
+## email_spam
+```json
+{
+	"id": string,
+	"type": "email_spam",
+ 	"organization_id": string,
+	"project_id": string
+    "domain_id": string,
+	"domain_name": string,
+    "created_at": string,
+	"email_sent_at": date,
+    "email_id": string,
+    "email_from": string,
+	"email_to": string,
+	"email_headers": [{"name": string, "value": string}],
+}
+```
+## email_deferred
+```json
+{
+	"id": string,
+	"type": "email_deferred",
+ 	"organization_id": string,
+	"project_id": string
+    "domain_id": string,
+	"domain_name": string,
+    "created_at": string,
+	"email_sent_at": date,
+    "email_id": string,
+    "email_from": string,
+	"email_to": string,
+	"email_headers": [{"name": string, "value": string}],
+	"email_error": string,
+	"email_next_try": date,
+	"email_try_count": integer
+}
+```
+