Email events

Exchange has identified and defined recognized events that often happen during email exchanges.

As an endpoint publisher, call https://api-exchange-us-1.goacoustic.com/v1/event to publish the event. The following example illustrates a typical JSON payload. This example is based on the Email Open event.

POST v1/event
{  
  “channel” : “Email”,
  “identifiers” : [            
    {
    “name” : “email”,
    “value” : “[email protected]”
    }
    ],
  “events” : [
    { 
    “code” : “emailOpen”, 
    “timestamp” : “2015-06-14T20:11:12Z”, 
    “attributes” : [
      {
      “name” : “eventName”,            
      “value” : “Email Open”,  
      “type” : “string” 
      } 
      {
      “name” : “messageId”,            
      “value” : “1211943”,  
      “type” : “string” 
      }      
      {
      “name” : “subjectLine”,            
      “value” : “Please come back!”,  
      “type” : “string” 
      }   
      {
      “name” : “mailingtemplateId”,            
      “value” : “GN8ntGD”,  
      “type” : “string” 
      }  
      ]
    }   
  ]
}

Email open

Information that describes an individual opening an email that relates to a product or brand.

Event code: emailOpen
Event attributes

Attribute NameData TypeExampleDescriptionRequired
descriptionstringDescription of the published event. Allow Acoustic Exchange users to understand the event context.
eventIdstringWeekly SaleUnique ID to identify the type of event and enable lookup in the system.
eventNamestringEmail OpenName of the event as it appears in the Exchange user interface.Yes
messageIdnumber1211943The unique identifier of the sent message associated with the event.Yes
messageNamestringWeekly Sale EmailThe user-defined name of the message.
subjectLinestringGreat DealsThe subject link of an email message.Yes
docTypestringHTMLThe type of email a contact received (Text or HTML).
mailingTemplateIdnumberGN8ntGDAn identifier used to group instances of sent messages. For Autoresponders, a single reportId is associated with every mailing for a day. For a recurring Automated Message, a single reportId is associated with each scheduled occurrence of a mailing. For a standard mailing, there is a one-to-one relationship between a ReportID and Mailing ID.
messageIdGroupstringThe unique identifier for a group of automated messages.

Email send

Information that describes sending an email related to a product or brand.

Event code: emailSend
Event attributes

Attribute NameData TypeExampleDescriptionRequired
descriptionstringDescription of the published event. Allow Exchange users to understand the event context.
eventIdstringWeekly SaleUnique ID to identify the type of event and enable lookup in the system.
eventNamestringEmail SendName of the event as it appears in the Exchange user interface.Yes
messageIdnumber1211943The unique identifier of the sent message associated with the event.Yes
messageNamestringWeekly Sale EmailThe user-defined name of the message.
subjectLinkstringGreat DealsThe subject line of an email message.Yes
docTypestringHTMLThe type of email a contact received (Text or HTML).
mailingTemplateIdnumberGN8ntGDUnique ID of the mailing template used for mailing.
reportIdstringAn identifier used to group instances of sent messages. For Autoresponders, a single reportId is associated with every email for a day. For a recurring Automated Message, a single reportId is associated with each scheduled occurrence of an email. For a standard email, there is a one-to-one relationship between a ReportID and Mailing ID.
messageIdGroupnumberThe unique identifier for a group of automated messages.

Email click

Information that relates to an individual clicking a link in an email.

Event code: emailClick
Event attributes

Attribute NameData TypeExampleDescriptionRequired
descriptionstringDescription of the published event. Allow Exchange users to understand the event context.
eventIdstringWeekly SaleUnique ID to identify the type of event and enable lookup in the system.
eventNamestringEmail ClickName of the event as it appears in the Exchange user interface.Yes
messageIdnumber1211943The unique identifier of the sent message associated with the event.Yes
messageNamestringWeekly Sale EmailThe user-defined name of the message.
subjectLinestringGreat DealsThe subject line of the email message.Yes
docTypestringHTMLThe type of email a contact received (Text or HTML).
mailingTemplateIdnumberGN8ntGDUnique ID of the email template used for emailing.
clickNamestringClick here for great deals!The user defined name of a hyperlink for a click or clickstream event (e.g. Download White
Paper)
urlURLThe URL of a hyperlink for a click or clickstream event.
reportIdstringAn identifier used to group instances of sent messages. For Autoresponders, a single reportId is associated with every email for a day. For a recurring Automated Message, a single reportId is associated with each scheduled occurrence of an email. For a standard email, there is a one-to-one relationship between a ReportID and Mailing ID.
messageIdGroupnumber>value>The unique identifier for a group of automated messages.

Email bounce

Information that relates to an email that was not delivered successfully.

Event code: emailBounce
Event attributes

Attribute NameData TypeExampleDescriptionRequired
descriptionstringDescription of the published event. Allow Exchange users to understand the event context.
eventIdstringWeekly SaleUnique ID to identify the type of event and enable lookup in the system.
eventNamestringEmail BounceName of the event as it appears in the Exchange user interface.Yes
messageIdnumber1211943The unique identifier of the sent message associated with the event.Yes
messageNamestringWeekly Sale EmailThe user-defined name of the message.
subjectLinestringGreat DealsThe subject link of an email message.Yes
docTypestringHTMLThe type of email a contact received (Text or HTML).
mailingTemplateIdnumberGN8ntGDUnique ID of the email template used for emailing.
reportIdstringAn identifier used to group instances of sent messages. For Autoresponders, a single reportId is associated with every email for a day. For a recurring Automated Message, a single reportId is associated with each scheduled occurrence of an email. For a standard email, there is a one-to-one relationship between a ReportID and Mailing ID.
bounceTypestringHEmail bounce type. For example, Hard bounce (H), or Soft bounce (S).
bounceDescstringEmail bounce type description.
messageIdGroupnumberThe unique identifier for a group of automated messages.

Email opt out

Information that describes how an email recipient opted out of an automated email program.

Event code: emailOptOut
Event attributes

Attribute NameData TypeExampleDescriptionRequired
eventIdstringUnique ID to identify the type of event and enable lookup in the system.
eventNamestringEmail Opt OutName of the event as it appears in the Exchange user interface.
descriptionstringDescription of the published event. Allows Exchange users to understand the event context.
messageIdnumberThe unique identifier of the sent message associated with the event.
messageNamestringThe user-defined name of the message.
subjectLinestringThe subject line of an email message.
docTypestringThe type of email a contact received (Text or HTML).
mailingTemplateIdnumberUnique ID of the email template used for emailing.
reportIdstringAn identifier used to group instances of sent messages. For Autoresponders, a single reportId is associated with every mailing for a day. For a recurring Automated Message, a single reportId is associated with each scheduled occurrence of a mailing. For a standard mailing, there is a one-to-one relationship between a ReportID and Mailing ID.
campaignCodestringA unique identifier for a group of automated messages.
campaignNameNew Year – New Opportunities!Name of the campaign conducted to generate customer interactions.