email-v3
Details of an email that was sent (without additional enrichment)
Webhook Payload
The webhook event is encapsulated within a common wrapper structure providing general information about the event.
Property | Type | Description |
---|---|---|
id | string | The unique identifier for the event. |
version | string | The version of the event. |
occurredAt | string | The date and time when the event occurred. |
tenantId | string | The unique identifier for the tenant. |
tenantName | string | The name of the tenant. |
data | object | Data of event data object details |
application | ['string'] | The application associated with the event |
productArea | string | The product area associated with the event. |
data object details
Property | Type | Description |
---|---|---|
interactionId | string | The unique identifier for the interaction. |
deliveryOptionName | string | The name of the delivery option. |
interactionOccurredAt | string | The date and time when the interaction occurred. |
deliveryOptionId | string | The unique identifier for the delivery option. |
userId | string | The unique identifier for the user. |
actionType | string | The type of action. |
clientDetails | object | Client Details clientDetails object details |
recipients | array of objects | Recipients recipients array object details |
interactionGroup | object | Interaction Group interactionGroup object details |
action | string | The action taken. |
links | array of objects | Links links array object details |
userEmail | string | The email address of the user. |
object | Email email object details | |
status | string | The status of the interaction. |
clientDetails object details
Property | Type | Description |
---|---|---|
productArea | string | The product area. |
deviceType | string | The type of device. |
browser | string | The browser used. |
operatingSystem | string | The operating system used. |
application | string | The application used. |
browserVersion | string | The version of the browser. |
operatingSystemVersion | string | The version of the operating system. |
locale | string | The locale. |
applicationType | string | The type of application. |
recipients array object details
Property | Type | Description |
---|---|---|
affiliateId | string | The unique identifier for the affiliate. |
id | string | The unique identifier for the recipient. |
string | The email address of the recipient. | |
recipientType | string | The type of recipient. |
context | array | The context for the recipient. |
interactionGroup object details
Property | Type | Description |
---|---|---|
id | string | The unique identifier for the interaction group. |
name | string | The name of the interaction group. |
links array object details
Property | Type | Description |
---|---|---|
allowDownload | boolean | Indicates if download is allowed. |
downloadFormats | array | The formats available for download. |
content | array of objects | Content content array object details |
createdAt | string | The date and time when the link was created. |
createdBy | string | The unique identifier for the creator of the link. |
hasPassword | boolean | Indicates if the link has a password. |
id | string | The unique identifier for the link. |
isLive | boolean | Indicates if the link is live. |
isSeparateSend | boolean | Indicates if the link is a separate send. |
notificationMode | string | The notification mode for the link. |
normalizedId | string | The normalized identifier for the link. |
urlPath | string | The URL path for the link. |
isLivesendExperience | boolean | Indicates if the link is a LiveSend experience. |
expiresAt | string | The expiration date and time for the link. |
content array object details
Property | Type | Description |
---|---|---|
totalPages | integer | The total number of pages. |
id | string | The unique identifier for the content. |
versionId | string | The version identifier for the content. |
quickAccessPath | ['string', 'null'] | The quick access path for the content. |
pages | array | The pages of the content. |
repository | string | The repository where the content is stored. |
type | string | The type of content. |
name | string | The name of the content. |
email object details
Property | Type | Description |
---|---|---|
id | string | The unique identifier for the email. |
subject | string | The subject of the email. |
emailTemplateInstances | array of objects | Email Template Instances emailTemplateInstances array object details |
emailTemplateInstances array object details
Property | Type | Description |
---|---|---|
id | string | The unique identifier for the email template instance. |
position | integer | The position of the email template instance. |
createdAt | string | The date and time when the email template instance was created. |
isReadOnly | boolean | Indicates if the email template instance is read-only. |
variableValues | array | The variable values for the email template instance. |
isSenderCreated | boolean | Indicates if the email template instance was created by the sender. |
sectionSelections | array of objects | Section Selections sectionSelections array object details |
sectionSelections array object details
Property | Type | Description |
---|---|---|
id | string | The unique identifier for the section selection. |
isReadOnly | boolean | Indicates if the section selection is read-only. |
optionName | string | The option name of the section selection. |
sectionName | string | The name of the section. |
sectionType | string | The type of the section. |
isChangedFromDefault | boolean | Indicates if the section selection is changed from default. |
Example
{
"application": "Web",
"data": {
"interactionId": "7642a8ca-ced5-465a-ba49-1a5191ef9996",
"deliveryOptionName": "LiveSend",
"interactionOccurredAt": "2024-04-30T09:28:17.537Z",
"deliveryOptionId": "1756e8d5-dd7c-4921-9d3e-e8d57f402183",
"userId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
"actionType": "built-in",
"clientDetails": {
"productArea": "livesend",
"deviceType": "unknown",
"browser": "unknown",
"operatingSystem": "unknown",
"application": "doccenter",
"applicationType": "seismic"
},
"recipients": [
{
"affiliateId": "29d605b1-c9a1-456d-b056-77828b13557f",
"id": "8eda18ec-4d45-74ba-04de-7d7951ade7e2",
"email": "[email protected]",
"recipientType": "to",
"context": []
}
],
"interactionGroup": {
"id": "5f7a6019-96d0-4988-a5ee-dc673d86d5a9"
},
"action": "Livesend",
"links": [
{
"allowDownload": true,
"downloadFormats": [
"Original"
],
"content": [
{
"totalPages": 54,
"contentProfileId": "26518764-925a-490d-92a5-0c5fc713f585",
"contentProfilePath": [
"Software-Architecture-Patterns"
],
"quickAccessPath": null,
"libraryContent": {
"teamsiteId": "1",
"id": "6482e7c5-dbdc-40d4-9254-539db3c2f90c",
"versionId": "d2a0e6e7-3a47-4b98-952c-a42f5e73aae7"
},
"pages": [
{
"id": "00000000-0000-0000-0000-000000000000",
"index": 0,
"thumbnailImageId": "00000000-0000-0000-0000-000000000000"
}
],
"id": "26518764-925a-490d-92a5-0c5fc713f585",
"repository": "doccenter",
"type": "file",
"name": "Software-Architecture-Patterns"
},
{
"totalPages": 1,
"contentProfileId": "52da2ad9-876f-4fbe-b5fb-ac385908ef28",
"contentProfilePath": [
"by Journey Stage",
"Awareness",
"C-Suite Thought Leadership"
],
"quickAccessPath": null,
"libraryContent": {
"teamsiteId": "1",
"id": "dbcce31b-3712-41f4-aab5-a19317c90aca",
"versionId": "e6d65da7-4114-402b-a912-ca159438300c"
},
"pages": [
{
"id": "00000000-0000-0000-0000-000000000000",
"index": 0,
"thumbnailImageId": "00000000-0000-0000-0000-000000000000"
}
],
"id": "52da2ad9-876f-4fbe-b5fb-ac385908ef28",
"repository": "doccenter",
"type": "file",
"name": "C-Suite Thought Leadership"
}
],
"createdAt": "2024-04-30T09:27:55.212838Z",
"createdBy": "b26fa7a6-5010-7ce1-8cf2-9fc6a414dfdf",
"hasPassword": false,
"id": "19ce582c-2c25-6e3f-c1ca-6122ed29cda8",
"isLive": true,
"isSeparateSend": true,
"notificationMode": "summary",
"normalizedId": "19ce582c-2c25-6e3f-c9ca-6122ed29cda8",
"urlPath": "https://demo.seismic.com/i/Ji9LXR6E9yPT___3PsxFHb3S___ukrlHe6XppSMI8fvb0Za49IyHV48Iw7Y",
"isLivesendExperience": false,
"expiresAt": "2024-05-16T09:26:26.483Z"
}
],
"userEmail": "[email protected]",
"email": {
"id": "0767c031-47b4-4552-bf56-b19444c93716",
"subject": "test",
"emailTemplateInstances": [
{
"id": "b94607c7-debd-4678-8f8b-ec81e089d411",
"position": 1,
"createdAt": "2024-04-30T09:27:58.543205Z",
"isReadOnly": false,
"variableValues": [],
"isSenderCreated": true,
"sectionSelections": [
{
"id": "dd684bd7-e4b7-4421-919a-0dcbe5e90dbc",
"isReadOnly": false,
"optionName": "test",
"sectionName": "untitled",
"sectionType": "Subject",
"isChangedFromDefault": false
},
{
"id": "a139a875-7e20-4e9b-a5fd-1a5943bb0fd6",
"isReadOnly": false,
"optionName": "Untitled",
"sectionName": "untitled",
"sectionType": "Text Block",
"isChangedFromDefault": false
}
]
}
]
},
"status": "sent"
},
"id": "dea65441-4c8e-424e-e9c2-efdea64474b7",
"version": "email-enriched-v3",
"occurredAt": "2024-04-30T09:28:25.515159+00:00",
"tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
"tenantName": "demo",
"productArea": "livesend"
}
Updated 3 days ago