Class: Stripe::V2::EventDestination

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/event_destination.rb

Overview

Set up an event destination to receive events from Stripe across multiple destination types, including [webhook endpoints](docs.stripe.com/webhooks) and [Amazon EventBridge](docs.stripe.com/event-destinations/eventbridge). Event destinations support receiving [thin events](docs.stripe.com/api/v2/events) and [snapshot events](docs.stripe.com/api/events).

Defined Under Namespace

Classes: AmazonEventbridge, StatusDetails, WebhookEndpoint

Constant Summary collapse

OBJECT_NAME = 
"v2.core.event_destination"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amazon_eventbridge ⇒ Object (readonly)

Amazon EventBridge configuration.



68
69
70
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 68

def amazon_eventbridge
  @amazon_eventbridge
end

#created ⇒ Object (readonly)

Time at which the object was created.



38
39
40
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 38

def created
  @created
end

#description ⇒ Object (readonly)

An optional description of what the event destination is used for.



40
41
42
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 40

def description
  @description
end

#enabled_events ⇒ Object (readonly)

The list of events to enable for this endpoint.



42
43
44
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 42

def enabled_events
  @enabled_events
end

#event_payload ⇒ Object (readonly)

Payload type of events being subscribed to.



44
45
46
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 44

def event_payload
  @event_payload
end

#events_from ⇒ Object (readonly)

Where events should be routed from.



46
47
48
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 46

def events_from
  @events_from
end

#id ⇒ Object (readonly)

Unique identifier for the object.



48
49
50
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 48

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



50
51
52
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 50

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Metadata.



52
53
54
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 52

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Event destination name.



54
55
56
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 54

def name
  @name
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value of the object field.



56
57
58
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 56

def object
  @object
end

#snapshot_api_version ⇒ Object (readonly)

If using the snapshot event payload, the API version events are rendered as.



58
59
60
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 58

def snapshot_api_version
  @snapshot_api_version
end

#status ⇒ Object (readonly)

Status. It can be set to either enabled or disabled.



60
61
62
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 60

def status
  @status
end

#status_details ⇒ Object (readonly)

Additional information about event destination status.



62
63
64
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 62

def status_details
  @status_details
end

#type ⇒ Object (readonly)

Event destination type.



64
65
66
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 64

def type
  @type
end

#updated ⇒ Object (readonly)

Time at which the object was last updated.



66
67
68
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 66

def updated
  @updated
end

#webhook_endpoint ⇒ Object (readonly)

Webhook endpoint configuration.



70
71
72
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 70

def webhook_endpoint
  @webhook_endpoint
end

Class Method Details

.object_name ⇒ Object 



9
10
11
 
# File 'lib/stripe/resources/v2/event_destination.rb', line 9

def self.object_name
  "v2.core.event_destination"
end