Lettermint.Types.ListWebhooksQuery (Lettermint v2.0.0)

Copy Markdown View Source

Query parameters of GET /webhooks (listWebhooks).

Pass them as a map with nested maps for bracketed names: %{page: %{size: 10}} is sent as page[size]=10. Lists of values are joined with commas, lists of maps are indexed and booleans are sent as 1 or 0.

Parameters

  • page[size] (optional)
  • cursor (optional): Cursor for the next or previous page.
  • sort (optional)
  • filter[project] (optional): Filter by project ID
  • filter[enabled] (optional): Filter by enabled status
  • filter[event] (optional): Filter by specific event type
  • filter[route_id] (optional): Filter by route ID
  • filter[scope] (optional): Filter by webhook scope
  • filter[search] (optional): Search by webhook name or URL

Summary

Types

t()

Functions

__params__()

The wire names of the parameters with their decode specs.

Types

t()

@type t() :: %{
  optional(:cursor) => String.t(),
  optional(:sort) => [Lettermint.Types.ListWebhooksQuerySortItem.t()],
  optional(:page) => %{optional(:size) => integer()},
  optional(:filter) => %{
    optional(:project) => String.t(),
    optional(:enabled) => boolean(),
    optional(:event) => Lettermint.Types.WebhookEvent.t(),
    optional(:route_id) => String.t(),
    optional(:scope) => Lettermint.Types.WebhookScope.t(),
    optional(:search) => String.t()
  }
}

Functions

__params__()

The wire names of the parameters with their decode specs.