email-enriched-v3

Details of an email that was sent (with additional enrichment)

Webhook Payload

The webhook event is encapsulated within a common wrapper structure providing general information about the event.

PropertyTypeDescription
idstringThe unique identifier for the event.
versionstringThe version of the event.
occurredAtstringThe date and time when the event occurred.
tenantIdstringThe unique identifier for the tenant.
tenantNamestringThe name of the tenant.
dataobjectData of event data object details
application['string']The application associated with the event.
productAreastringThe product area associated with the event.

data object details

PropertyTypeDescription
interactionIdstringThe unique identifier for the interaction.
deliveryOptionNamestringThe name of the delivery option.
interactionOccurredAtstringThe date and time when the interaction occurred.
deliveryOptionIdstringThe unique identifier for the delivery option.
userIdstringThe unique identifier for the user.
actionTypestringThe type of action.
clientDetailsobjectClient Details clientDetails object details
recipientsarray of objectsRecipients recipients array object details

clientDetails object details

PropertyTypeDescription
productAreastringThe product area.
deviceTypestringThe type of device.
browserstringThe browser used.
operatingSystemstringThe operating system used.
applicationstringThe application used.
browserVersionstringThe version of the browser.
operatingSystemVersionstringThe version of the operating system.
localestringThe locale.
applicationTypestringThe type of application.

recipients array object details

PropertyTypeDescription
affiliateIdstringThe unique identifier for the affiliate.
idstringThe unique identifier for the recipient.
recipientTypestringThe type of recipient.
Contextarray of objectsContext Context array object details
interactionGroupobjectInteraction Group interactionGroup object details
actionstringThe action taken.
linksarray of objectsLinks links array object details
userEmailstringThe email address of the user.
emailobjectEmail email object details
statusstringThe status of the interaction.

Context array object details

PropertyTypeDescription
ContextIdstringUnique identifier for the context.
ContextTypestringType of context.
SystemTypestringType of system.
SystemIdstringUnique identifier for the system.
ContextNamestringName of the context.
ContextEmailstringEmail address of the context.
SourcestringSource of the context.
SourceTypestringType of source.

interactionGroup object details

PropertyTypeDescription
idstringThe unique identifier for the interaction group.
namestringThe name of the interaction group.

links array object details

PropertyTypeDescription
allowDownloadbooleanIndicates if download is allowed.
downloadFormatsarrayThe formats available for download.
contentarray of objectsContent content array object details
createdAtstringThe date and time when the link was created.
createdBystringThe unique identifier for the creator of the link.
hasPasswordbooleanIndicates if the link has a password.
idstringThe unique identifier for the link.
isLivebooleanIndicates if the link is live.
isSeparateSendbooleanIndicates if the link is a separate send.
notificationModestringThe notification mode for the link.
normalizedIdstringThe normalized identifier for the link.
urlPathstringThe URL path for the link.
isLivesendExperiencebooleanIndicates if the link is a LiveSend experience.
expiresAtstringThe expiration date and time for the link.

content array object details

PropertyTypeDescription
totalPagesintegerThe total number of pages.
idstringThe unique identifier for the content.
versionIdstringThe version identifier for the content.
quickAccessPath['string', 'null']The quick access path for the content.
pagesarrayThe pages of the content.
repositorystringThe repository where the content is stored.
typestringThe type of content.
namestringThe name of the content.

email object details

PropertyTypeDescription
idstringThe unique identifier for the email.
subjectstringThe subject of the email.
emailTemplateInstancesarray of objectsEmail Template Instances emailTemplateInstances array object details

emailTemplateInstances array object details

PropertyTypeDescription
idstringThe unique identifier for the email template instance.
positionintegerThe position of the email template instance.
createdAtstringThe date and time when the email template instance was created.
isReadOnlybooleanIndicates if the email template instance is read-only.
variableValuesarrayThe variable values for the email template instance.
isSenderCreatedbooleanIndicates if the email template instance was created by the sender.
sectionSelectionsarray of objectsSection Selections sectionSelections array object details

sectionSelections array object details

PropertyTypeDescription
idstringThe unique identifier for the section selection.
isReadOnlybooleanIndicates if the section selection is read-only.
optionNamestringThe option name of the section selection.
sectionNamestringThe name of the section.
sectionTypestringThe type of the section.
isChangedFromDefaultbooleanIndicates 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",
        "userEmail": "[email protected]",
        "recipientType": "to",
        "Context": [
          {
            "ContextId": "0021b00002BYS8HAAX",
            "ContextType": "Account",
            "SystemType": "Salesforce",
            "SystemId": "00D300000000AaEEAU",
            "ContextName": "Demo Contacts",
            "ContextEmail": "[email protected]",
            "Source": "seismic-attribution",
            "SourceType": "heuristic"
          }
        ]
      }
    ],
    "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": null,
            "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": null,
            "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"
}