PolarExpress.Events.OrderUpdated (polar_express v0.1.5)

Copy Markdown View Source

Webhook event for order.updated.

Sent when an order is updated.

An order is updated when:

  • Its status changes, e.g. from pending to paid.
  • It's refunded, partially or fully.

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.OrderUpdated{
  data: PolarExpress.Schemas.Order.t(),
  timestamp: String.t(),
  type: String.t()
}
  • type - Always "order.updated".
  • 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.