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

Email send

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

Event code: emailSend
Event attributes

Email click

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

Event code: emailClick
Event attributes

Email bounce

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

Event code: emailBounce
Event attributes

Email opt out

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

Event code: emailOptOut
Event attributes