Skip to navigation
API ReferenceSandbox and testingTest helpers

Send a test webhook event

Sends a signed sample event of the given type to one endpoint and waits up to 15 seconds for the response, so you can test a handler and its signature check. The event points at related_object when you pass one, otherwise at a placeholder object. The result includes the delivery attempt.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

webhook_endpoint_idstringRequired

The webhook endpoint ID (we_...).

Request

This endpoint expects an object.
typeenumRequired
New types may be added. Subscribe only to the ones you handle.
related_objectstringOptional
A sandbox object ID for the event to point at, such as an outcome charge.

Response

The test event, with its delivery attempt.
idstring
object"webhook_event"
typeenum
New types may be added. Subscribe only to the ones you handle.
api_versionstring
related_objectobject
livemodeboolean
created_atdatetime
reasonobjectOptional
What caused the event.
contextobjectOptional

The fields that identify what a limit, window or purchase event is about, for events that don’t name a stored object of their own. Fetch related_object for the current state.

delivery_statusenumOptional

pending: still being sent or retried. succeeded: every subscribed endpoint acknowledged it. failed: retries ran out for at least one endpoint.

Allowed values:
deliverieslist of objectsOptional
Retrieve only. The last 10 attempts per endpoint.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error