ePrivacy and GPDR Cookie Consent by Cookie Consent Skip to main content

System events for Emails

Once you have successfully configured the Email channel, system events will automatically populate in the CDP under the Meiro Emails source. This documentation provides a comprehensive overview of these system events along with their structures and examples.

Campaign Email Sent 

This event is triggered when an email campaign is activated and an email is sent to a customer. 

Event Type: mea_sent
Retention: No retention, but customizable

Event Structure:

{
  activation_id: unique_activation_id, // required number
  campaign: { // required object
    id: "uuid", // required string
    name: "Campaign Name", //required string
    },
  email: "customer@example.com", // required
  message_id: "uuid", // required string
  subject: "Email subject", // required string
  utm_parameters: { // optional object
    campaign: "value", // optional string
    content: "value", // optional string
    medium: "value", // optional string
    source: "value", // optional string
    term: "value" // optional string
    },
  customer_attributes: {
        // Additional customer attributes here
    }
}

Event example:

{
  "activation_id": 2,
  "campaign": {
    "id": "283be389-f280-4b06-9b33-3efbb207d468",
    "name": "Welcome Campaign"
  },
  "customer_attributes": {
    "mx_first_name_last": "Navrotska"
  },
  "email": "test@meiro.io",
  "message_id": "d35a7c51-7f08-47ad-8ea5-7967139ca2ad",
  "subject": "Welcome to Meiro",
  "utm_parameters": {
    "campaign": "welcome_campaign",
    "content": "email_newsletter",
    "medium": "",
    "source": "",
    "term": ""
  }
}

Email Address Block Imported

This event occurs when analysts import a blocklist of email addresses from an external mailing tool. This event can be imported with the Meiro Integration “upload to CDP” loader. Learn more about the process in this article.

Event Type: mea_address_block_imported
Retention: Not applicable (not changeable)

Event Structure:


{
  email: "customer@example.com", // required
  reason: "some reason", // optional string
  // possible additional payload data
}

Event Example:

{
  "email": "test@meiro.io",
  "reason": "Spam complaints received"
}

Email Address Blocked

This event occurs when an email address is blocked within the CDP, either manually or through automated processes (e.g., via block or bounce webhook).

Event Type: mea_address_blocked
Retention: Not applicable (not changeable)
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required
  message_id: "uuid", // optional string
  reason: "some reason", // optional string
  blocked_by: "CDP user name (userId) | hard_bounce_webhook | block_webhook" // required string
  subject: "Email subject", // optional string
  type: "email_address_blocked"
}

Event Example:

{
  "email": "test@gmail.com",
  "message_id": "5e2ad54e-3e8b-44f0-abf3-696eece395fd",
  "reason": "",
 "blocked_by": "block_webhook"
   "subject": "Subscribe to our newsletter!",
  "type": "email_address_blocked"
}

Email Address Unblocked

This event occurs when an email address is unblocked within the CDP.

Event Type: mea_address_unblocked
Retention: Not applicable (not changeable)

Event Structure:

{
  email: "customer@example.com", // required
  reason: "some reason" // optional string
  unblocked_by: "CDP user name (userId) | hard bounce" // required string
}

Event Example:

{
  "email": "test@meiro.io",
  "reason": "Customer requested unblock",
  "unblocked_by": "Administrator (User ID: 1)"
}

Email Bounced

This event occurs when an email fails to be delivered to the recipient's inbox.

Event Type: mea_bounce
Retention: Not applicable (not changeable)
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required
  code: { // optional block
    basic: "string",
    enhanced: "string"
  },
  reason: "Temporary system problem. Try again later.", // required string
  bounce_type: "hard/soft" //required
  message_id: "uuid", // required string
  subject: "Email subject", // optional string
  type: "email_bounced"
 // possible additional payload data (campaign name, id, subject...)
}

Event Example:

{
  "email": "test@meiro.io",
  "code": {
    "basic": "550",
    "enhanced": "5.1.1"
  },
  "reason": "Recipient mailbox is full",
  "bounce_type": "hard",
  "message_id": "602e0a38-7d90-4222-9aae-543f00154a0a",
  "subject": "Your Weekly Newsletter",
  "type": "email_bounced"
}

Email Click 

This event is triggered when a customer clicks on a link within an email. 

Event Type: mea_click
Retention: No retention, but customizable
Autoload: enabled

Event Structure:

{
  campaign: { // required object
    id: "uuid", // required string
    name: "Email campaign name", // required string
  },
  message_id: "uuid", required string,
  redirect_url: "required string",
  subject: "Subject", // required string
  email: "customer@example.com", // required email address, validation via regex
  type: "email_link_click"
}

Event Example:

{
  "campaign": {
    "id": "d46d229e-93a2-4d55-a542-e5c4ac5ef8a9",
    "name": "Summer Discounts"
  },
  "message_id": "b372e8c7-09f4-4a1b-89ca-518ac3b9e1e3",
  "redirect_url": "https://example.com/summer-sale",
  "subject": "Get your favourite camera 20% cheaper!",
  "email": "test@meiro.io",
  "type": "email_link_click"
}

Email Delivered 

This event occurs when an email is successfully delivered to the recipient's inbox.

Event Type: mea_delivered
Retention: No retention, but customizable
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required
  message_id: "uuid", // required string
  subject: "Email subject", // optional string
  type: "email_delivered"
}

Event Example:

{
  "email": "test@meiro.io",
  "message_id": "2b7f3a19-3a08-47e1-b894-04a1505fcf8d",
  "subject": "Your Weekly Newsletter",
  "type": "email_delivered"
}

Email Open

This event occurs when a customer opens an email, indicating engagement with the content.

Event Type: mea_open
Retention: No retention, but customizable
Autoload: enabled

Event Structure:

{
  campaign: { // required object
    id: "uuid", // required string
    name: "Name of email", // required string
  },
  message_id: "uuid", // required string
  email: "customer@example.com", // required email address
 subject: "Email subject", // required string
  type: "email_open"
}

Event Example:

{
  "campaign": {
    "id": "f7d9c62e-1a4f-4d3c-9f3a-7f4528d0e6a1",
    "name": "Spring Sale Newsletter"
  },
  "message_id": "a3b2e8f1-09d7-4e9a-b3f5-62a7c8b4e126",
  "email": "test@meiro.io",
  "subject": "Exclusive Deals Inside!",
  "type": "email_open"
}

Email Spam Complaint 

This event occurs when a customer marks an email as spam.

Event Type: mea_spam_complaint
Retention: Not applicable (not changeable)
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required
  message_id: "uuid", // required string
  subject: "subject email", // optional string
  type: "spam_complaint"
}

Event Example:

{
  "email": "test@meiro.io",
  "message_id": "b372e8c7-09f4-4a1b-89ca-518ac3b9e1e3",
  "subject": "Your monthly newsletter",
  "type": "spam_complaint"
}

Email Subscription Confirmed 

This event occurs when a customer confirms their subscription to an email list.

Event Type: mea_subscription_confirmed
Retention: Not applicable (not changeable)
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required
  message_id: "uuid", // required string
  redirect_url: "string" // required string (url/path)
  subscription_request_id: "uuid" // required string
  type: "subscription_confirm"
}

Event Example:

{
  "email": "test@meiro.io",
  "message_id": "b47736f1-bf15-4f08-81bb-71249ecd4e22",
 "redirect_url": "https://www.meiro.store/",
  "remote_addr": "178.26.0.7:37932",
  "subscription_request_id": "ca0ffb48-d294-4d56-888d-22e643cbbab6",
  "type": "subscription_confirm"
}

Email Subscription Imported

This event occurs when analysts import a contact list for a one-time subscription from an external mailing service. This event can be imported with the Meiro Integration “upload to CDP” loader. Learn more about the process in this article. 

Event Type: mea_subscription_imported
Retention: Not applicable (not changeable)

Event Structure:

{
  email: "customer@example.com", // required
  consent: true, //required boolean, true/false
  subscription_source: "string", // optional string
 //possible additional payload data
}

Event Example:

{
  "email": "test@meiro.io",
  "consent": true,
  "subscription_source": "Website footer form"
}

Email Subscription Requested

This event occurs when a customer requests to subscribe to an email list.

Event Type:  mea_subscription_requested
Retention: Not applicable (not changeable)
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required, email address regex validation
  subscription_source: "string", // optional string
  subscription_request_id: "uuid" // required string,
  type: "subscription_request"
}

Event Example:

{
  "email": "test@meiro.io",
  "subscription_request_id": "ba0ffb48-d294-4d56-888d-22e643cbbab6",
  "subscription_source": "Meiro banner: 2733f584-0f85-4942-a570-86300dd3963e",
  "type": "subscription_request"
}

Email Unsubscribed

This event occurs when a customer unsubscribes from an email list.

Event Type: mea_unsubscribe
Retention: Not applicable (not changeable)
Autoload: enabled

Event Structure:

{
  email: "customer@example.com", // required
  campaign: { // optional object
    id: "uuid", // required string
    name: "email_name", // required string
  },
  message_id: "uuid", // optional string message_id
  unsubscribe_source: "", // optional string
  subject: "email subject", // optional string
  type: "unsubscribe"
}

Event Example:

{
  "email": "test@meiro.io",
  "campaign": {
    "id": "f7d9c62e-1a4f-4d3c-9f3a-7f4528d0e6a1",
    "name": "Newsletter"
  },
  "message_id": "b47736f1-bf15-4f08-81bb-71249ecd4e22",
  "unsubscribe_source": "Website footer form",
  "subject": "Your weekly newsletter",
  "type": "unsubscribe"
}

Opt-in Subscription Email Sent 

This event occurs when an opt-in subscription confirmation email is sent to a customer.

Event Type: mea_opt_in_subscription_email_sent
Retention: Not applicable (not changeable)

Event Structure:

{
  email: "customer@example.com", // required
  message_id: "uuid", // required string
  subscription_request_id: "uuid", // required string
  subject: "string" // required string
}

Event Example:

{
  "email": "test@meiro.io",
  "message_id": "v47736f1-bf15-4f08-81bb-71249ecd4e22",
  "subject": "Subscribe to our newsletter!",
  "subscription_request_id": "ca0ffb48-d294-4d56-888d-22e643cbbab6"
}

No Comments
Back to top