Defines the object schema located at components.schemas.webhook_endpoint in the specification.
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
WebhookEndpointwebhookEndpointApiVersion :: Maybe (Nullable Text)api_version: The API version events are rendered as for this webhook endpoint.
Constraints:
Maximum length of 5000
webhookEndpointApplication :: Maybe (Nullable Text)application: The ID of the associated Connect application.
Constraints:
Maximum length of 5000
webhookEndpointCreated :: Intcreated: Time at which the object was created. Measured in seconds since the Unix epoch.
webhookEndpointDescription :: Maybe (Nullable Text)description: An optional description of what the webhook is used for.
Constraints:
Maximum length of 5000
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 :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
webhookEndpointLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
webhookEndpointMetadata :: Objectmetadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
webhookEndpointSecret :: Maybe Textsecret: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
Constraints:
Maximum length of 5000
webhookEndpointStatus :: Textstatus: The status of the webhook. It can be `enabled` or `disabled`.
Constraints:
Maximum length of 5000
webhookEndpointUrl :: Texturl: The URL of the webhook endpoint.
Constraints:
Maximum length of 5000
Instances4Eq, Show, FromJSON, ToJSON
Eq WebhookEndpointDefined in stripeapi-3.0.0.0 · StripeAPI.Types.WebhookEndpointShow WebhookEndpointDefined in stripeapi-3.0.0.0 · StripeAPI.Types.WebhookEndpointFromJSON WebhookEndpointDefined in stripeapi-3.0.0.0 · StripeAPI.Types.WebhookEndpointToJSON WebhookEndpointDefined in stripeapi-3.0.0.0 · StripeAPI.Types.WebhookEndpoint