v1

latestOpenAPI 3.1.02026-07-22100167210.7 KB
Environments

Test Start Hook (Streaming)

Provisions an isolated sandbox, runs the supplied start hook script, and streams output back as Server-Sent Events. Use this instead of a synchronous test endpoint to avoid gateway timeouts on long-running hooks. Events emitted: progress (status messages), output (captured stdout/stderr), complete (final exit_code and timed_out), and error (terminal failure).

post/v1/environments/{environmentId}/start-hooks/test/stream

Path parameters

environmentIdstring required

Environment UUID, or the literal string global.

Request body

contentstring required

Shell script to execute (not persisted)

Response

SSE stream of start hook test events