View Source WorkOS.Events (WorkOS SDK for Elixir v1.1.0)

Manage Events API in WorkOS.

@see https://workos.com/docs/events

Summary

Functions

list_events(opts \\ %{})
list_events(client, opts)

Lists all events.

Functions

Link to this function

list_events(opts \\ %{})

View Source 
@spec list_events(map()) ::
  WorkOS.Client.response(WorkOS.List.t(WorkOS.Events.Event.t()))
Link to this function

list_events(client, opts)

View Source 
@spec list_events(WorkOS.Client.t(), map()) ::
  WorkOS.Client.response(WorkOS.List.t(WorkOS.Events.Event.t()))

Lists all events.

Parameter options:

  • :events - Filter to only return events of particular types.
  • :range_start - Date range start for stream of events.
  • :range_end - Date range end for stream of events.
  • :limit - Maximum number of records to return. Accepts values between 1 and 100. Default is 10.
  • :after - Pagination cursor to receive records after a provided event ID.