PolarExpress.Events.OrderPaid (polar_express v0.1.5)

Copy Markdown View Source

Webhook event for order.paid.

Sent when an order is paid.

When you receive this event, the order is fully processed and payment has been received.

Discord & Slack support: Full

The data field contains a PolarExpress.Schemas.Order struct.

Summary

Types

t()

Functions

event_type()

Returns the event type string.

Types

t()

@type t() :: %PolarExpress.Events.OrderPaid{
  data: PolarExpress.Schemas.Order.t(),
  timestamp: String.t(),
  type: String.t()
}
  • type - Always "order.paid".
  • data - The event payload. See PolarExpress.Schemas.Order.
  • timestamp - ISO 8601 timestamp of when the event occurred.

Functions

event_type()

@spec event_type() :: String.t()

Returns the event type string.