POST /v1/webhook_endpoints/{webhook_endpoint}
Updates the webhook endpoint. You may edit the url
, the list of enabled_events
, and the status of your endpoint.
Servers
- https://api.stripe.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
webhook_endpoint |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
description |
No |
An optional description of what the webhook is used for. |
|
url |
String | No |
The URL of the webhook endpoint. |
disabled |
Boolean | No |
Disable the webhook endpoint if set to true. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
No |
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
|
enabled_events[] |
Array | No |
The list of events to enable for this endpoint. You may specify |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.