Update a webhook endpoint

Changed on

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

post/v1/webhook_endpoints/{webhook_endpoint}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/webhook_endpoints/{webhook_endpoint}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

webhook_endpointstring required

Request body application/x-www-form-urlencoded

disabledboolean

Disable the webhook endpoint if set to true.

enabled_eventsstring[]

The list of events to enable for this endpoint. You may specify ['*'] to enable all events, except those that require explicit selection.

expandstring[]

Specifies which fields in the response should be expanded.

urlstring

The URL of the webhook endpoint.

Response

Successful response.

api_versionstring nullable

The API version that events are rendered as for this webhook endpoint. You can't change this value after you create the endpoint.

applicationstring nullable

The ID of the associated Connect application.

createdinteger required

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

descriptionstring nullable

An optional description of what the webhook is used for.

enabled_eventsstring[] required

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'webhook_endpoint' required

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

secretstring

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

statusstring required

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

urlstring required

The URL of the webhook endpoint.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.