Deskhero Developer Hub
Back to deskhero.com
Webhooks

Test

Sends a sample "ticket.created" payload to the webhook synchronously (the body carries "test": true) and returns the response status code and duration, for verifying the endpoint and signature handling.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/webhooks/{id}/test
Authorisation
Minimum role: ADMIN

Request arguments

Name Type Source
idInt32
Request body example

Response

Status
200 (OK)
Type
DTO_webhook_test_result
Wrapper
DTO_response_wrap
Other statuses
401 (Unauthorized), 403 (Forbidden), 404 (NotFound), 429 (TooManyRequests)
Response body example
DTO_webhook_test_result
NameTypeReadOnlyDescription
http_status_codeInt32 (nullable)Http status code
okBooleanOk
errorStringError
duration_msInt64Duration ms

Generated Aug 31, 2026 16:21