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

As an endpoint publisher, call https://api-01.ubx.ibmmarketingcloud.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” : “jdoe@example.com”
    }
    ],
  “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 Name Data Type Example Description Required
description string <description> Description of the published event. Allow UBX users to understand the event context.  
eventId string Weekly Sale Unique ID to identify the type of event and enable lookup in the system.  
eventName string Email Open Name of the event as it appears in the UBX user interface. Yes
messageId number 1211943 The unique identifier of the sent message associated with the event. Yes
messageName string Weekly Sale Email The user-defined name of the message.  
subjectLine string Great Deals The subject line of an email message. Yes
docType string HTML The type of email a contact received (Text or HTML).  
mailingTemplateId number GN8ntGD Unique ID of the mailing template used for mailing.  
reportId string <value> An 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.
 
messageIdGroup string <value> The 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 Name Data Type Example Description Required
description string <description> Description of the published event. Allow UBX users to understand the event context.  
eventId string Weekly Sale Unique ID to identify the type of event and enable lookup in the system.  
eventName string Email Send Name of the event as it appears in the UBX user interface. Yes
messageId number 1211943 The unique identifier of the sent message associated with the event. Yes
messageName string Weekly Sale Email The user-defined name of the message.  
subjectLine string Great Deals The subject line of an email message. Yes
docType string HTML The type of email a contact received (Text or HTML).  
mailingTemplateId number GN8ntGD Unique ID of the mailing template used for mailing.  
reportId string <value> An 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.
 
messageIdGroup number <value> The 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 Name Data Type Example Description Required
description string <description> Description of the published event. Allow UBX users to understand the event context.  
eventId string Weekly Sale Unique ID to identify the type of event and enable lookup in the system.  
eventName string Email Click Name of the event as it appears in the UBX user interface. Yes
messageId number 1211943 The unique identifier of the sent message associated with the event. Yes
messageName string Weekly Sale Email The user-defined name of the message.  
subjectLine string Great Deals The subject line of an email message. Yes
docType string HTML The type of email a contact received (Text or HTML).  
mailingTemplateId number GN8ntGD Unique ID of the mailing template used for mailing.  
clickName string Click here for great deals! The user defined name of a hyperlink for a click or clickstream event (e.g. Download White
Paper)
 
url URL <URL> The URL of a hyperlink for a click or clickstream event.  
reportId string <value> An 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.
 
messageIdGroup number <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 Name Data Type Example Description Required
description string <description> Description of the published event. Allow UBX users to understand the event context.  
eventId string Weekly Sale Unique ID to identify the type of event and enable lookup in the system.  
eventName string Email Bounce Name of the event as it appears in the UBX user interface. Yes
messageId number 1211943 The unique identifier of the sent message associated with the event. Yes
messageName string Weekly Sale Email The user-defined name of the message.  
subjectLine string Great Deals The subject line of an email message. Yes
docType string HTML The type of email a contact received (Text or HTML).  
mailingTemplateId number GN8ntGD Unique ID of the mailing template used for mailing.  
reportId string <value> An 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.
 
bounceType string H Email bounce type. For example, Hard bounce (H), or Soft bounce (S).  
bounceDesc string <value> Email bounce type description.  
messageIdGroup number <value> The unique identifier for a group of automated messages.  

Email opt out

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

Event code: emailOptOut

Event attributes

Attribute Name Data Type Example Description Required
eventId string <value> Unique ID to identify the type of event and enable lookup in the system.  
eventName string Email Opt Out Name of the event as it appears in the UBX user interface.  
description string <description> Description of the published event. Allows UBX users to understand the event context.  
messageId number <value> The unique identifier of the sent message associated with the event.  
messageName string <value> The user-defined name of the message.  
subjectLine string <value> The subject line of an email message.  
docType string <value> The type of email a contact received (Text or HTML).  
mailingTemplateId number <value> Unique ID of the mailing template used for mailing.  
reportId string <value> An 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.
 
campaignCode string <campaign specific> A unique identifier for a group of automated messages.  
campaignName string New Year – New Opportunities! Name of the campaign conducted to generate customer interactions.  

Join The Discussion

Your email address will not be published. Required fields are marked *