HTTP Target

HTTP Target properties for Script Engine. Calls an HTTP endpoint and reports back the response, status code and timing. Useful for triggering web hooks when a project starts, posting telemetry to a control system, polling REST APIs as part of a show, integrating with cloud automation workflows or pinging health-check endpoints from the running composition. The result can be passed back to the Script Engine via the optional callback function.

Property Type Access Description
EndPoint string get/set The full URL to call, including scheme (http:// or https://) and any query string already attached. Additional parameters can be appended automatically via the Parameters property. Avoid placing API keys directly in this URL when the project file may be shared.
Parameters string get/set Optional extra query-string parameters that get appended to EndPoint with an & separator. Useful for adding dynamic values from the Script Engine without having to rebuild the full URL each time. Leave empty if all parameters are already part of EndPoint.
ExecuteAtStart bool get/set Fires the HTTP request automatically when the project starts. Useful for sending a "stream is live" notification, registering with a control system or kicking off a downstream workflow. Combine with AutoStartDelayMs if the receiving service needs a moment to come online first.
AutoStartDelayMs AutoStartDelayMs get/set How long to wait after project start before firing the request when ExecuteAtStart is enabled. Useful when the receiving service or another target needs a head-start (for example, an RTMP encoder that should be live before the notification is sent).
OnSuccessScriptCallback string get/set Name of a Script Engine function to invoke when the request completes successfully (HTTP 2xx). The response body is passed in as a string argument so the script can parse it. Leave empty to skip the callback.
Status GenericComponentStatus get Current status of the target. Ready means idle and ready to fire, Busy means a request is in flight.
HttpGetCommand Command get Fires the HTTP request immediately using the current EndPoint and Parameters values. Useful from the Script Engine to send ad-hoc notifications triggered by user actions, cuepoints or other in-show logic.
StopCommand Command get Cancels a request that is currently in flight. Has no effect if no request is running.
LastHttpCommandDateTime DateTime get Date and time the latest HTTP request was sent (read-only, debug).
LastHttpCommand String get The full URL of the last request, including any appended parameters (read-only, debug). Handy for verifying that template substitutions resolved as expected.
LastHttpStatusCode int get HTTP status code returned by the last request (read-only, debug). 200 means success; 4xx indicates a client problem (bad URL, missing auth); 5xx indicates a server problem on the receiving end.
LastHttpResponse string get Response body returned by the last request (read-only, debug). Typically JSON, plain text or HTML depending on the receiving service.
ResponseTimeMs long get How long the last request took, in milliseconds (read-only, debug). Useful for spotting slow endpoints that could affect show timing.
NumRequests int get Total number of requests sent since the project was loaded (read-only, debug).
Minilog FormattedMessage get Latest status or error message from the target (read-only, debug).

Inherits from: AbstractTarget.

See also: HTTP Target in Targets — user-facing introduction, screenshots, and section summaries.