Stripe: Webhook endpoints schemas

← Webhook endpoints operations · All schemas

Create a webhook endpoint — response body

Field	Type	Presence	Description and constraints
$	object	Root	You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be notified about events that happen in your Stripe account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints. Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)
api_version	JSON	Optional
api_version (anyOf 1)	string	Alternative	The API version that events are rendered as for this webhook endpoint. You can't change this value after you create the endpoint.
api_version (anyOf 2)	null	Alternative
application	JSON	Optional
application (anyOf 1)	string	Alternative	The ID of the associated Connect application. Maximum length: 5000
application (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	JSON	Optional
description (anyOf 1)	string	Alternative	An optional description of what the webhook is used for. Maximum length: 5000
description (anyOf 2)	null	Alternative
enabled_events	array	Required within parent	The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.
enabled_events[]	string	Each item	Maximum length: 5000
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: webhook_endpoint
secret	string	Optional	The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation. Maximum length: 5000
status	string	Required within parent	The status of the webhook. It can be `enabled` or `disabled`. Maximum length: 5000
url	string	Required within parent	The URL of the webhook endpoint. Maximum length: 5000

Delete a webhook endpoint — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: webhook_endpoint