PolarExpress.Events.CustomerCreated (polar_express v0.1.5)

Copy Markdown View Source

Webhook event for customer.created.

Sent when a new customer is created.

A customer can be created:

  • After a successful checkout.
  • Programmatically via the API.

Discord & Slack support: Basic

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

Summary

Functions

Returns the event type string.

Types

t()

@type t() :: %PolarExpress.Events.CustomerCreated{
  data: PolarExpress.Schemas.Customer.t(),
  timestamp: String.t(),
  type: String.t()
}
  • type - Always "customer.created".
  • data - The event payload. See PolarExpress.Schemas.Customer.
  • timestamp - ISO 8601 timestamp of when the event occurred.

Functions

event_type()

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

Returns the event type string.