Messaging

To track an event using the messaging package, you can use the corresponding method on the tracker instance. For example:

Example

val properties = MessagingMessageSentProperties(
    contextId = contextId
)
bird.tracker.messaging.messageSent(properties)

Methods

messageSent()

val properties = MessagingMessageSentProperties(
    contextId = contextId
)
bird.tracker.messaging.messageSent(properties)

MessagingMessageSentProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

use_case_type?

String

variation?

String

messageRead()

val properties = MessagingMessageReadProperties(
    contextId = contextId
)
bird.tracker.messaging.messageRead(properties)

MessagingMessageReadProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

use_case_type?

String

variation?

String

messageBounced()

val properties = MessagingMessageBouncedProperties(
    contextId = contextId
)
bird.tracker.messaging.messageBounced(properties)

MessagingMessageBouncedProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

use_case_type?

String

variation?

String

messageDeliveryFailed()

val properties = MessagingMessageDeliveryFailedProperties(
    contextId = contextId
)
bird.tracker.messaging.messageDeliveryFailed(properties)

MessagingMessageDeliveryFailedProperties

Property
Type

context_id?

String

failure_reason?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

use_case_type?

String

variation?

String

messageDelivered()

val properties = MessagingMessageDeliveredProperties(
    contextId = contextId
)
bird.tracker.messaging.messageDelivered(properties)

MessagingMessageDeliveredProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

use_case_type?

String

variation?

String

messageMarkedSpam()

val properties = MessagingMessageMarkedSpamProperties(
    contextId = contextId
)
bird.tracker.messaging.messageMarkedSpam(properties)

MessagingMessageMarkedSpamProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

use_case_type?

String

variation?

String

messageOpened()

val properties = MessagingMessageOpenedProperties(
    contextId = contextId
)
bird.tracker.messaging.messageOpened(properties)

MessagingMessageOpenedProperties

Property
Type

context_id?

String

flow_id?

String

inbox_provider?

String

journey_id?

String

message_id?

String

platform_id?

String

recipient_domain?

String

use_case_type?

String

variation?

String

messageSubscribed()

val properties = MessagingMessageSubscribedProperties(
    contextId = contextId
)
bird.tracker.messaging.messageSubscribed(properties)

MessagingMessageSubscribedProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

subscription_action?

Any

use_case_type?

String

variation?

String

messageUnsubscribed()

val properties = MessagingMessageUnsubscribedProperties(
    contextId = contextId
)
bird.tracker.messaging.messageUnsubscribed(properties)

MessagingMessageUnsubscribedProperties

Property
Type

context_id?

String

flow_id?

String

journey_id?

String

message_id?

String

platform_id?

String

subscription_action?

Any

use_case_type?

String

variation?

String

messageLinkClicked()

val properties = MessagingMessageLinkClickedProperties(
    contextId = contextId
)
bird.tracker.messaging.messageLinkClicked(properties)

MessagingMessageLinkClickedProperties

Property
Type

context_id?

String

flow_id?

String

inbox_provider?

String

journey_id?

String

message_id?

String

platform_id?

String

recipient_domain?

String

url?

String

use_case_type?

String

variation?

String

Last updated