diff --git a/managed-services/transactional-email/api-cli/webhook-events-payloads.mdx b/managed-services/transactional-email/api-cli/webhook-events-payloads.mdx index bd4d9864f0..fb22e00beb 100644 --- a/managed-services/transactional-email/api-cli/webhook-events-payloads.mdx +++ b/managed-services/transactional-email/api-cli/webhook-events-payloads.mdx @@ -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 @@ -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 } ] @@ -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 } ```