v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB
Hook

Test Hook

Send a test event to a webhook endpoint.

Delivers a sample payload to the hook's URL with a single attempt (no retries) for fast feedback.

post/hooks/{hook_id}/test

Path parameters

hook_idstring uuid required

Request body

eventstring nullable

Event type to simulate (default: completed)

Response

Successful Response

idstring uuid required

The hook ID

successboolean required

Whether delivery succeeded (2xx)

statusCodeinteger nullable

HTTP status from target

errorstring nullable

Error message if delivery failed