Skip to main content
POST
Delivers a test event to a registered webhook and returns your endpoint’s response. Use it to confirm an endpoint is reachable before you depend on it.

Authentication

Send your Encrata API key in the Authorization header with the Bearer prefix.
Testing a webhook requires the workspace admin or tech role. readonly keys get 403.

Request

string
required
The webhook ID to send the test event to.

What your endpoint receives

The test always advertises itself as a test event, so your production handler will not mistake it for a real one.
Test payload
For a generic webhook the request carries the same headers as a real delivery, including X-Encrata-Signature and X-Encrata-Event: test. Chat destinations receive their provider’s message format instead. The attempt is recorded, so it also appears in delivery history.

Response

Returns 200 OK whenever the test ran, even if your endpoint rejected it. Read result.status to learn the delivery outcome.
boolean
true when the test was executed. This describes the API call, not your endpoint’s reply.
object
string
A human-readable summary.
A failed test is still success: true with HTTP 200. The API call worked; the delivery did not. Branch on result.status.

Errors

Example error

Next steps