Lettermint.Types.MessageEventData (Lettermint v2.1.0)

Copy Markdown View Source

schema:MessageEventData.

Fields

  • message_id (required)
  • event (required)
  • tag (required, nullable)
  • tags (required)
  • metadata (required, nullable): Event-specific metadata. For opened and clicked events, reason_codes and engagement.reason_codes list broad categories behind the bot classification: privacy_proxy, image_proxy, link_protection, known_bot, security_network, timing, link_pattern, request_shape, unconfirmed, confirmed, sandbox or other. New categories can be added. Use classification and counts_for_metrics for decisions
  • timestamp (required)

Absent fields are :unset; nil is JSON null. extra holds response fields that this version of the SDK does not know.

Summary

Types

t()

@type t() :: %Lettermint.Types.MessageEventData{
  event: Lettermint.Types.MessageEventType.t(),
  extra: %{optional(String.t()) => term()},
  message_id: String.t(),
  metadata: %{optional(String.t()) => term()} | nil,
  tag: String.t() | nil,
  tags: [Lettermint.Types.MessageTag.t()],
  timestamp: String.t()
}