Skip to main content
POST
POST /v1/webhook-endpoints/{endpointId}/test
The endpoint must be verified and subscribed to the event type, or the request returns 409 WEBHOOK_TEST_BLOCKED. Send now. { "type": "payment.succeeded" } sends a signed example payload right away and returns your receiver’s http_status, with accepted: true for a 2xx response. Nothing is stored. Queue. { "type": "card_enrollment.completed", "queued": true } checks the queued delivery path. The endpoint must also be enabled. The response is { "queued": true, "event_id": "evt_…" }. The test event then appears in List deliveries and List events. Test payloads have "test": true and example data. They check delivery to your receiver, not enrollment or payment behavior. Returns 422 WEBHOOK_RECEIVER_UNAVAILABLE when the receiver can’t be reached securely. See Testing webhooks.

Authorizations

Authorization
string
header
required

Your secret key: sk_test_* (sandbox) or sk_live_* (production).

Path Parameters

endpointId
string
required

Body

application/json
type
enum<string>
required
Available options:
payment.credentials_ready,
payment.succeeded,
payment.failed,
card_enrollment.completed,
card_enrollment.failed,
card_enrollment.cancelled,
card_enrollment.expired,
mandate.created,
mandate.creation_failed,
mandate.creation_cancelled,
mandate.creation_expired,
mandate.paused,
mandate.resumed,
mandate.cancelled,
mandate.expired,
quote.request_failed
queued
boolean
default:false

Use queued delivery on an active endpoint; synthetic, non-financial data

Response

Successful operation; endpoints never include stored signing secrets.

http_status
integer
required

Your receiver's HTTP status.

accepted
boolean
required

true when the status was 2xx.