Skip to navigation

Send Webhook Endpoint Test Event

Fluveo extension (Test mode only): send one signed synthetic test event of type to this endpoint’s saved URL and answer what the endpoint returned. The event is marked in its signed body (livemode: false, fluveo_test_event: true, an evt_test_ id), is never listed in /v1/events, and is never retried. Disabled endpoints receive test events and stay disabled. Only saved URLs using https on port 443 can receive a test event. An optional Idempotency-Key header sets the test event id: the same key, endpoint, and event type always give the same evt_test_ id, and there is no replay journal. A malformed key (more than one header, empty, non-printable, or longer than 255 characters) is refused with 400. Any query parameter is refused with 400. Test events are off unless enabled for the environment; when off, the send is refused with 400 webhook_test_events_disabled. Limits, each a sustained rate with a burst of the same size: per store and mode sustained 20 per minute with bursts of 20; per endpoint sustained 5 per minute with bursts of 5; per destination host, store, and mode sustained 10 per minute with bursts of 10; per destination host across all stores sustained 300 per minute with bursts of 300.

Authentication

AuthorizationBasic

Standard Basic HTTP authentication. The username is the Fluveo secret key and the password must be empty, encoded as base64(api_key:).

OR
AuthorizationBearer

Bearer HTTP authentication. Allowed header: Authorization: Bearer <api_key>.

Path parameters

endpoint_idstringRequired

Request

This endpoint expects an object.
typeenumRequired

One of the 18 Stripe event types Fluveo delivers; platform hs.* types are refused

Response

Fluveo extension response: the outcome of the one test delivery (a failed delivery is still a 200)

createdinteger
event_idstringformat: "^evt_test_[A-Za-z0-9]{24}$"
event_typeenum
failure_codeenum or null
Allowed values:
latency_msinteger or null

Milliseconds from the request to the response headers; null when no request was made

livemodeboolean
objectenum
Allowed values:
response_excerptstring or null

At most the first 1024 bytes of the endpoint's answer, as text: control characters become spaces and every webhook signing secret with its prefix (any letter case) is redacted. Returned once and never stored; null when no body was read, including routers built with the local webhook allowlist.

response_excerpt_truncatedboolean
response_statusinteger or null
resultenum
Allowed values:
webhook_endpointstring

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error