Skip to main content
Schema2020-08-27object

webhook_endpoint

You can configure [webhook endpoints](https://stripe.com/docs/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://stripe.com/docs/webhooks/configure).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

NotificationWebhookEndpoint

object

You can configure [webhook endpoints](https://stripe.com/docs/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://stripe.com/docs/webhooks/configure).

api_version string
optionalnullable

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

application string
optionalnullable

The ID of the associated Connect application.

created integer (unix-time)
required

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

description string
optionalnullable

An optional description of what the webhook is used for.

enabled_events array
required

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

id string
required

Unique identifier for the object.

livemode boolean
required

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

metadata object
required

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

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

secret string
optional

The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation.

status string
required

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

url string
required

The URL of the webhook endpoint.