Lettermint.WebhookPayload (Lettermint v2.1.0)

Copy Markdown View Source

A verified webhook delivery.

  • id: the delivery id
  • event: the event name, for example "message.delivered". Event names the SDK does not know pass through as strings; see Lettermint.Types.WebhookEvent.values/0.
  • timestamp: when the event occurred, ISO 8601
  • data: the event data, decoded JSON with string keys
  • extra: every other top-level field (such as context), with string keys

Summary

Types

t()

Types

t()

@type t() :: %Lettermint.WebhookPayload{
  data: term(),
  event: Lettermint.Types.WebhookEvent.t() | nil,
  extra: %{optional(String.t()) => term()},
  id: String.t() | nil,
  timestamp: String.t() | nil
}