Skip to main content
POST
Send a test event to a webhook endpoint

Authorizations

Authorization
string
header
required

Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.

Headers

Idempotency-Key
string
required

Unique key per logical request, reused on retries. 1 to 255 characters, kept for 24 hours. A retry with the same key and body returns the stored response with the header Idempotent-Replayed: true.

Required string length: 1 - 255

Path Parameters

id
string
required

Body

application/json
type
enum<string>
default:payment.captured
Available options:
checkout_session.completed,
checkout_session.expired,
payment.authorized,
payment.captured,
payment.partially_captured,
payment.failed,
payment.canceled,
payment.expired,
payment.amount_updated,
payment.amount_mismatch,
payment.fraud_reported,
capture.failed,
refund.succeeded,
refund.failed,
dispute.created,
dispute.updated,
dispute.funds_withdrawn,
dispute.won,
dispute.lost,
payment_method.attached,
payment_method.updated,
payment_method.detached

Response

The delivery result.

object
string
required
Allowed value: "webhook_test_delivery"
webhook_endpoint
string
required
Example:

"we_01JABCDEF"

event
object
required
delivered
boolean
required

True if your endpoint answered with a 2xx.

status_code
integer | null
required

HTTP status your endpoint returned. null if it could not be reached.

error
string | null
required

Why the delivery failed, for example HTTP 500 or a timeout.

duration_ms
integer
required