Send a test delivery
Posts a synthetic webhook.test event to the endpoint while you wait, signed like any delivery, and answers with the delivery record: status is DELIVERED when your receiver answered 2xx, otherwise FAILED with responseStatus and error.
- One attempt: a failed test is not retried, and does not count towards the automatic disable. A 2xx resets the endpoint's run of failed events without re-enabling it.
- It works on a disabled endpoint — the way to check a receiver before turning it back on.
- The attempt waits up to 5 s to connect and 10 s for the answer, so this call can take that long.
USE THIS WHEN: verifying a new receiver, or checking signature verification. DO NOT USE WHEN: replaying a real event — this one carries no job data.
Request
- Base URL: https://api.imagestep.dev
- URL: https://api.imagestep.dev/api/v1/webhook-endpoints/{id}/test
- Auth: API key in header Authorization
Path parameters
The endpoint's id (whe_…), as create and the listing return it
Headers
Optional. A client-generated unique key (typically a UUID). Same key + the same request (method, path, query string and body) replays the first response verbatim with Idempotency-Replayed: true, without executing again. Same key + a different one returns 409 idempotency_key_reuse. A repeat that arrives while the first is still running returns 409 request_in_progress, which is retryable. Keys are retained 24 hours. At most 255 characters; a longer one is a 400 invalid_param with param: "Idempotency-Key".
Response
The attempt was made — read status: an unreachable receiver is a FAILED delivery, not an error
Changes
No recorded changes to this operation across all 1 revision of this API.