Column.Events (Column v1.0.0)

Copy Markdown View Source

Immutable audit log of every state change on the Column platform.

Every object mutation emits a typed event with a type string and a data payload. Use events for reconciliation by polling, or pair with webhooks for real-time push delivery.

Common event types

  • bank_account.created, bank_account.updated
  • transfer.ach.created, transfer.ach.settled, transfer.ach.returned
  • transfer.wire.created, transfer.wire.settled
  • transfer.book.created, transfer.book.cleared
  • transfer.realtime.created, transfer.realtime.settled
  • transfer.check.issued, transfer.check.settled
  • loan.created, loan.disbursement.cleared
  • entity.kyc.approved, entity.kyc.denied

Example

{:ok, page} = Column.Events.list(limit: 25)
events = page["data"]
Enum.each(events, fn event ->
  process_event(event)
end)

Summary

Functions

Get an event by ID.

List all events. Supports cursor pagination and optional type filter.

List all available webhook event types.

Types

id()

@type id() :: String.t()

opts()

@type opts() :: keyword()

result()

@type result() :: {:ok, map()} | {:error, Column.Error.t()}

Functions

get(id, opts \\ [])

@spec get(id(), opts()) :: result()

Get an event by ID.

list(opts \\ [])

@spec list(opts()) :: result()

List all events. Supports cursor pagination and optional type filter.

list_webhook_event_types(opts \\ [])

@spec list_webhook_event_types(opts()) :: result()

List all available webhook event types.