class Stripe::WebhookEndpoint

• Stripe::WebhookEndpoint
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #api_version : String | Nil
• #api_version=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application : String | Nil
• #application=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #enabled_events : Array(String) | Nil
• #enabled_events=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #secret : String | Nil
• #secret=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #url : String | Nil
• #url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail