Increase.EventSubscriptions.EventSubscription (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.

Fields

  • id - The event subscription identifier.
  • created_at - The time the event subscription was created.
  • idempotency_key - The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  • oauth_connection_id - If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.
  • selected_event_categories - If specified, this subscription will only receive webhooks for Events with the specified category.
  • status - This indicates if we'll send notifications to this subscription.
  • type - A constant representing the object's type. For this resource it will always be event_subscription.
  • url - The webhook url where we'll send notifications.

Summary

Types

t()

Types

t()

@type t() :: %Increase.EventSubscriptions.EventSubscription{
  created_at: DateTime.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  oauth_connection_id: String.t() | nil,
  selected_event_categories:
    [Increase.EventSubscriptions.EventSubscription.SelectedEventCategory.t()]
    | nil,
  status: String.t(),
  type: String.t(),
  url: String.t()
}