Messaging

Message events use the $message Semantic Object. This includes a type such as "email", "sms" or "web-push" which defines the type of message.

Message Sent

Indicate that a message has been sent.

Interface

interface MessageSent {
  event: 'Message Sent'
  properties: {
    $message: Message
  }
}

Message Bounced

Indicate that a message bounced when trying to send.

Interface

interface MessageBounced {
  event: 'Message Bounced'
  properties: {
    $message: Message
  }
}

Message Errored

Indicate that a message errored when trying to send. This is used for errors that are not bounces.

Interface

interface MessageErrored {
  event: 'Message Errored'
  properties: {
    $message: Message
  }
}

Message Reported

Indicate that a message has been reported as Junk or SPAM.

Interface

interface MessageReported {
  event: 'Message Reported'
  properties: {
    $message: Message
  }
}

Message Delivered

Indicate that a message was delivered.

Interface

interface MessageDelivered {
  event: 'Message Delivered'
  properties: {
    $message: Message
  }
}

Message Viewed

Indicate that a message was viewed.

Interface

interface MessageViewed {
  event: 'Message Viewed'
  properties: {
    $message: Message
  }
}

Message Interacted

Indicate that a message has been viewed.

Interface

interface MessageInteracted {
  event: 'Message Interacted'
  properties: {
    $message: Message
  }
}

Message Subscribed

Indicate that a message type was subscribed to.

Interface

interface MessageSubscribed {
  event: 'Message Subscribed'
  properties: {
    $message: Message
  }
}

Message Unsubscribed

Indicate that a message type was unsubscribed from.

Interface

interface MessageUnsubscribed {
  event: 'Message Unsubscribed'
  properties: {
    $message: Message
  }
}

Message Consent Requested

Indicates that consent has been requested to message a user. For Web Push this would be used to indicate that the browser Web Push authorization was requested. For emails it may be that an email was sent confirming subscription status.

Interface

interface MessageConsentRequested {
  event: 'Message Consent Requested'
  properties: {
    $message: Message
  }
}

Message Consent Granted

Indicates that a user granted consent to be messaged. For Web Push this would be used to indicate that the browser Web Push authorization was granted by the user. For emails it may be that an email was sent confirming subscription status, and the user clicked the link in this email.

Interface

interface MessageConsentGranted {
  event: 'Message Consent Granted'
  properties: {
    $message: Message
  }
}

Message Consent Denied

Indicates that a user denied (or removed) consent to be messaged. For Web Push this would be used to indicate that the browser Web Push authorization was not granted by the user. For emails it may be that a user unsubscribed from an email list.

Interface

interface MessageConsentDenied {
  event: 'Message Consent Denied'
  properties: {
    $message: Message
  }
}

Last updated