Attributes
- idstring
Unique identifier for the object.
- api_
versionnullable string The API version events are rendered as for this webhook endpoint.
- descriptionnullable string
An optional description of what the webhook is used for.
- enabled_
eventsarray of strings The list of events to enable for this endpoint.
['*']indicates that all events are enabled, except those that require explicit selection. - metadataobject
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.
- secretstring
The endpoint’s secret, used to generate webhook signatures. Only returned at creation.
- statusstring
The status of the webhook. It can be
enabledordisabled. - urlstring
The URL of the webhook endpoint.
More attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- applicationnullable string
The ID of the associated Connect application.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
{ "id": "we_1Mr5jULkdIwHu7ix1ibLTM0x", "object": "webhook_endpoint", "api_version": null, "application": null, "created": 1680122196, "description": null, "enabled_events": [ "charge.succeeded", "charge.failed" ], "livemode": false, "metadata": {}, "secret": "whsec_wRNftLajMZNeslQOP6vEPm4iVx5NlZ6z", "status": "enabled", "url": "https://example.com/my/webhook/endpoint"}