Increase.EventSubscriptions (Increase v1.0.0)

Copy Markdown View Source

Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your developer dashboard or the API. For more information, see our webhooks guide.

See https://increase.com/documentation/api/event-subscriptions for the full API reference for this resource.

Summary

Functions

create(client, params \\ %{}, opts \\ [])

Create an Event Subscription

list(client, params \\ %{}, opts \\ [])

List Event Subscriptions

retrieve(client, event_subscription_id, opts \\ [])

Retrieve an Event Subscription

update(client, event_subscription_id, params \\ %{}, opts \\ [])

Update an Event Subscription

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.EventSubscriptions.EventSubscription.t()}
  | {:error, Increase.Error.t()}

Create an Event Subscription

POST /event_subscriptions

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Event Subscriptions

Returns a %Increase.Page{} whose data is a list of %__MODULE__. EventSubscription{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /event_subscriptions

retrieve(client, event_subscription_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.EventSubscriptions.EventSubscription.t()}
  | {:error, Increase.Error.t()}

Retrieve an Event Subscription

GET /event_subscriptions/{event_subscription_id}

update(client, event_subscription_id, params \\ %{}, opts \\ [])

@spec update(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.EventSubscriptions.EventSubscription.t()}
  | {:error, Increase.Error.t()}

Update an Event Subscription

PATCH /event_subscriptions/{event_subscription_id}