WebhookEmailReadPayload
EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.
Properties
| Name | Type | Description | Notes |
| messageId | String | Idempotent message ID. Store this ID locally or in a database to prevent message duplication. | |
| webhookId | UUID | ID of webhook entity being triggered | |
| eventName | EventNameEnum | Name of the event type webhook is being triggered for. | |
| webhookName | String | Name of the webhook being triggered | [optional] |
| emailId | UUID | ID of the email that was received. Use this ID for fetching the email with the EmailController. | |
| inboxId | UUID | Id of the inbox that received an email | |
| emailIsRead | Boolean | Is the email read | |
| createdAt | OffsetDateTime | Date time of event creation | |
Enum: EventNameEnum
| Name | Value |
| EMAIL_RECEIVED | "EMAIL_RECEIVED" |
| NEW_EMAIL | "NEW_EMAIL" |
| NEW_CONTACT | "NEW_CONTACT" |
| NEW_ATTACHMENT | "NEW_ATTACHMENT" |
| EMAIL_OPENED | "EMAIL_OPENED" |
| EMAIL_READ | "EMAIL_READ" |
| BOUNCE | "BOUNCE" |
| BOUNCE_RECIPIENT | "BOUNCE_RECIPIENT" |