Skip to navigation

Send Test Event

Send one event’s example payload to this endpoint only. The request is signed like a real event, and its payload has data.test set to true and placeholder ids. Use it to check the receiver’s signature verification without starting a job.

The body is optional; event_type defaults to job.completed. Follow the result with the deliveries and attempts endpoints.

Path parameters

endpoint_idstringRequired

The endpoint’s id (whe_...).

Request

This endpoint expects a nullable object.
event_typestringOptionalDefaults to job.completed

Which event’s example payload to send. Defaults to job.completed.

Response

Successful Response
endpoint_idstring
message_idstring
The test message's id. Use it with the attempts endpoint.
event_typeenum
Allowed values:
testboolean

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error