Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our webhooks guide.
See https://increase.com/documentation/api/events for the full API reference for this resource.
Summary
Functions
@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}
List Events
Returns a %Increase.Page{} whose data is a list of %__MODULE__. Event{} structs. Page through results with
Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.
GET /events
@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.Events.Event.t()} | {:error, Increase.Error.t()}
Retrieve an Event
GET /events/{event_id}