Stripe.Resources.V2.Core.EventDestination (tiger_stripe v0.3.0)

Copy Markdown View Source

Event Destination

Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints and Amazon EventBridge. Event destinations support receiving thin events and snapshot events.

Summary

Types

amazon_eventbridge()
status_details()
status_details_disabled()
t()
webhook_endpoint()

Functions

object_name()

Types

amazon_eventbridge()

@type amazon_eventbridge() :: %{
  optional(:aws_account_id) => String.t() | nil,
  optional(:aws_event_source_arn) => String.t() | nil,
  optional(:aws_event_source_status) => String.t() | nil,
  optional(String.t()) => term()
}
  • aws_account_id - The AWS account ID.
  • aws_event_source_arn - The ARN of the AWS event source.
  • aws_event_source_status - The state of the AWS event source. Possible values: active, deleted, pending, unknown.

status_details()

@type status_details() :: %{
  optional(:disabled) => status_details_disabled() | nil,
  optional(String.t()) => term()
}
  • disabled - Details about why the event destination has been disabled.

status_details_disabled()

@type status_details_disabled() :: %{
  optional(:reason) => String.t() | nil,
  optional(String.t()) => term()
}
  • reason - Reason event destination has been disabled. Possible values: no_aws_event_source_exists, user.

t()

@type t() :: %Stripe.Resources.V2.Core.EventDestination{
  amazon_eventbridge: amazon_eventbridge() | nil,
  created: String.t(),
  description: String.t(),
  enabled_events: [String.t()],
  event_payload: String.t(),
  events_from: [String.t()] | nil,
  id: String.t(),
  livemode: boolean(),
  metadata: %{required(String.t()) => String.t()} | nil,
  name: String.t(),
  object: String.t(),
  snapshot_api_version: String.t() | nil,
  status: String.t(),
  status_details: status_details() | nil,
  type: String.t(),
  updated: String.t(),
  webhook_endpoint: webhook_endpoint() | nil
}
  • amazon_eventbridge - Amazon EventBridge configuration.
  • created - Time at which the object was created. Format: date-time.
  • description - An optional description of what the event destination is used for.
  • enabled_events - The list of events to enable for this endpoint.
  • event_payload - Payload type of events being subscribed to. Possible values: snapshot, thin.
  • events_from - Where events should be routed from.
  • id - Unique identifier for the object.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • metadata - Metadata.
  • name - Event destination name.
  • object - String representing the object's type. Objects of the same type share the same value of the object field. Possible values: v2.core.event_destination.
  • snapshot_api_version - If using the snapshot event payload, the API version events are rendered as.
  • status - Status. It can be set to either enabled or disabled. Possible values: disabled, enabled.
  • status_details - Additional information about event destination status.
  • type - Event destination type. Possible values: amazon_eventbridge, webhook_endpoint.
  • updated - Time at which the object was last updated. Format: date-time.
  • webhook_endpoint - Webhook endpoint configuration.

webhook_endpoint()

@type webhook_endpoint() :: %{
  optional(:signing_secret) => String.t() | nil,
  optional(:url) => String.t() | nil,
  optional(String.t()) => term()
}
  • signing_secret - The signing secret of the webhook endpoint, only includable on creation.
  • url - The URL of the webhook endpoint, includable.

Functions

object_name()