class

Stripe::WebhookEndpoint

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts. Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints. Related guide: Setting up webhooks

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [webhook_endpoint]."
MAX_LENGTH_FOR_API_VERSION = 5000
MAX_LENGTH_FOR_APPLICATION = 5000
MAX_LENGTH_FOR_DESCRIPTION = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_SECRET = 5000
MAX_LENGTH_FOR_STATUS = 5000
MAX_LENGTH_FOR_URL = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("webhook_endpoint")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, api_version : String | Nil = nil, application : String | Nil = nil, created : Int64 | Nil = nil, description : String | Nil = nil, enabled_events : Array(String) | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, status : String | Nil = nil, url : String | Nil = nil, secret : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

api_version

The API version events are rendered as for this webhook endpoint.

Source
api_version=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] api_version Object to be assigned

Source
application

The ID of the associated Connect application.

Source
application=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] application Object to be assigned

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
description

An optional description of what the webhook is used for.

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source
enabled_events

The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.

Source
enabled_events=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] enabled_events Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
secret

The endpoint's secret, used to generate webhook signatures. Only returned at creation.

Source
secret=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] secret Object to be assigned

Source
status

The status of the webhook. It can be enabled or disabled.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
url

The URL of the webhook endpoint.

Source
url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] url Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source