Create a Webhook
POST
/v1/webhook_endpointsA webhook endpoint must have a url and a list of enabled_events.
Request
An optional description of what the webhook is used for.
The list of events to enable for this endpoint.
Set of key-value pairs that you can attach to an object.
The URL of the webhook endpoint.
{
"description": "This is your description of the webhook",
"enabled_events": [
"payment_intent.succeeded",
"payment_intent.payment_failed",
"charge.refund.updated",
"charge.dispute.updated"
],
"url": "https://your_call_back_address.com"
}
Request samples
Responses
Unique identifier for the object, like "we_xxxxx"
"webhook_endpoint"
The API version events are rendered as for this webhook endpoint.
Time at which the object was created. Measured in seconds since the Unix epoch.
An optional description of what the webhook is used for.
The list of events to enable for this endpoint.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Set of key-value pairs that you can attach to an object.
The status of the webhook. It can be enabled or disabled.
The endpoint’s secret, used to generate webhook signatures. Only returned at creation.
The URL of the webhook endpoint.
{
"id": "we_1M3fqHHTdYyGj2Y6LeGVaamQ",
"object": "webhook_endpoint",
"api_version": null,
"created": 1668344601,
"description": "This is my webhook, I like it a lot",
"enabled_events": [
"payment_intent.succeeded",
"payment_intent.payment_failed",
"charge.refund.updated",
"charge.dispute.updated"
],
"livemode": false,
"metadata": {},
"status": "enabled",
"url": "https://example.com/my/webhook/endpoint",
"secret": "whsec_9rMfZUGWM3gTTBtn0f8kPEfmiIJCmzQi"
}