Update a webhook endpoint
Updates the webhook endpoint. You may edit the url
, the list of enabled_events
, and the status of your endpoint.
Parameters
- descriptionstring
An optional description of what the webhook is used for.
- enabled_
eventsarray of enums The list of events to enable for this endpoint. You may specify
['*']
to enable all events, except those that require explicit selection.Possible enum valuesaccount.application.authorized
Occurs whenever a user authorizes an application. Sent to the related application only.
account.application.deauthorized
Occurs whenever a user deauthorizes an application. Sent to the related application only.
account.external_account.created
Occurs whenever an external account is created.
account.external_account.deleted
Occurs whenever an external account is deleted.
account.external_account.updated
Occurs whenever an external account is updated.
account.updated
Occurs whenever an account status or property has changed.
application_fee.created
Occurs whenever an application fee is created on a charge.
application_fee.refund.updated
Occurs whenever an application fee refund is updated.
application_fee.refunded
Occurs whenever an application fee is refunded, whether from refunding a charge or from refunding the application fee directly. This includes partial refunds.
balance.available
Occurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis. This event is not fired for negative transactions.
Show 342 more - metadataassociative array
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
metadata
. - urlstring
The URL of the webhook endpoint.
More parameters
- disabledboolean
Returns
The updated webhook endpoint object if successful. Otherwise, this call throws an error.
{
"id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
"object": "webhook_endpoint",
"api_version": null,
"application": null,
"created": 1680122196,
"description": null,
"enabled_events": [
"charge.succeeded",
"charge.failed"
],
"livemode": false,
"metadata": {},
"status": "disabled",
"url": "https://example.com/new_endpoint"
}
Retrieve a webhook endpoint
Retrieves the webhook endpoint with the given ID.
Parameters
No parameters.
Returns
Returns a webhook endpoint if a valid webhook endpoint ID was provided. Throws an error otherwise.
{
"id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
"object": "webhook_endpoint",
"api_version": null,
"application": null,
"created": 1680122196,
"description": null,
"enabled_events": [
"charge.succeeded",
"charge.failed"
],
"livemode": false,
"metadata": {},
"status": "enabled",
"url": "https://example.com/my/webhook/endpoint"
}
List all webhook endpoints
Returns a list of your webhook endpoints.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A associative array with a data
property that contains an array of up to limit
webhook endpoints, starting after webhook endpoint starting_after
. Each entry in the array is a separate webhook endpoint object. If no more webhook endpoints are available, the resulting array will be empty. This request should never throw an error.
{
"object": "list",
"url": "/v1/webhook_endpoints",
"has_more": false,
"data": [
{
"id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
"object": "webhook_endpoint",
"api_version": null,
"application": null,
"created": 1680122196,
"description": null,
"enabled_events": [
"charge.succeeded",
"charge.failed"
],
"livemode": false,
"metadata": {},
"status": "enabled",
"url": "https://example.com/my/webhook/endpoint"
}
{...}
{...}
],
}
Delete a webhook endpoint
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
Parameters
No parameters.
Returns
An object with the deleted webhook endpoints’s ID. Otherwise, this call throws an error, such as if the webhook endpoint has already been deleted.
{
"id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
"object": "webhook_endpoint",
"deleted": true
}