Webhook Endpoint With Secret

A Webhook Endpoint with its signing secret, returned only when the endpoint is created or its secret is rotated. Store the secret securely and use it to verify incoming webhook signatures.

id*string

Unique identifier

object*"webhook_endpoint"

Value in

"webhook_endpoint"

url*string

The URL to send webhook events to

description*|

Human-readable description

status*string

Value in

"enabled"
"disabled"

enabledEvents*array<string>

Enabled event types; ['*'] subscribes to all events

livemode*boolean

Whether this endpoint exists in the live database

metadata*

Merchant-supplied custom metadata

createdAt*string

Creation timestamp (ISO 8601)

Formatdate-time

updatedAt*string

Last update timestamp (ISO 8601)

Formatdate-time

secret*string

One-time signing secret returned only on creation or rotation; store securely

{  "id": "string",  "object": "webhook_endpoint",  "url": "string",  "description": "string",  "status": "enabled",  "enabledEvents": [    "string"  ],  "livemode": true,  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "secret": "string"}