StripeAPI.Types.WebhookEndpoint

Contains the types generated from the schema WebhookEndpoint

Documentation

data WebhookEndpoint

Defines the data type for the schema webhook_endpoint

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.

Constructors

WebhookEndpoint

Fields

• webhookEndpointApiVersion :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• webhookEndpointApplication :: Maybe Text

  application: The ID of the associated Connect application.

  Constraints:

  • Maximum length of 5000
• webhookEndpointCreated :: Integer

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

• webhookEndpointEnabledEvents :: [] Text

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

• webhookEndpointId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• webhookEndpointLivemode :: Bool

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

• webhookEndpointObject :: WebhookEndpointObject'

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

• webhookEndpointSecret :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• webhookEndpointStatus :: Text

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

  Constraints:

  • Maximum length of 5000
• webhookEndpointUrl :: Text

  url: The URL of the webhook endpoint.

  Constraints:

  • Maximum length of 5000

Instances

Eq WebhookEndpoint

Defined in StripeAPI.Types.WebhookEndpoint

Methods

(==) :: WebhookEndpoint -> WebhookEndpoint -> Bool

(/=) :: WebhookEndpoint -> WebhookEndpoint -> Bool

Show WebhookEndpoint

Defined in StripeAPI.Types.WebhookEndpoint

Methods

showsPrec :: Int -> WebhookEndpoint -> ShowS

show :: WebhookEndpoint -> String

showList :: [WebhookEndpoint] -> ShowS

ToJSON WebhookEndpoint

Defined in StripeAPI.Types.WebhookEndpoint

Methods

toJSON :: WebhookEndpoint -> Value

toEncoding :: WebhookEndpoint -> Encoding

toJSONList :: [WebhookEndpoint] -> Value

toEncodingList :: [WebhookEndpoint] -> Encoding

FromJSON WebhookEndpoint

Defined in StripeAPI.Types.WebhookEndpoint

Methods

parseJSON :: Value -> Parser WebhookEndpoint

parseJSONList :: Value -> Parser [WebhookEndpoint]

data WebhookEndpointObject'

Defines the enum schema webhook_endpointObject'

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

Constructors

WebhookEndpointObject'EnumOther Value

WebhookEndpointObject'EnumTyped Text

WebhookEndpointObject'EnumStringWebhookEndpoint

Instances

Eq WebhookEndpointObject'

Defined in StripeAPI.Types.WebhookEndpoint

Methods

(==) :: WebhookEndpointObject' -> WebhookEndpointObject' -> Bool

(/=) :: WebhookEndpointObject' -> WebhookEndpointObject' -> Bool

Show WebhookEndpointObject'

Defined in StripeAPI.Types.WebhookEndpoint

Methods

showsPrec :: Int -> WebhookEndpointObject' -> ShowS

show :: WebhookEndpointObject' -> String

showList :: [WebhookEndpointObject'] -> ShowS

ToJSON WebhookEndpointObject'

Defined in StripeAPI.Types.WebhookEndpoint

Methods

toJSON :: WebhookEndpointObject' -> Value

toEncoding :: WebhookEndpointObject' -> Encoding

toJSONList :: [WebhookEndpointObject'] -> Value

toEncodingList :: [WebhookEndpointObject'] -> Encoding

FromJSON WebhookEndpointObject'

Defined in StripeAPI.Types.WebhookEndpoint

Methods

parseJSON :: Value -> Parser WebhookEndpointObject'

parseJSONList :: Value -> Parser [WebhookEndpointObject']