Q-SYS API Outbound

API Outbound is a Q-SYS plugin for triggering one outbound HTTP endpoint from a design and mapping selected JSON response fields back to output pins. Each plugin instance owns a single request target. The endpoint URL, port, method, and API key strategy are configured at design time. Runtime parameter values are supplied through text pins, and a trigger button or input pin sends the request on demand.

Utility

Choose license type

$179.99

Fully functional — purchase a license to activate.

Q-Sys Driver License

in partnership with

Screenshots

Main

The API Outbound Q-SYS Plugin sends one outbound HTTP request per plugin instance
and maps selected response fields back into the Q-SYS design.
Each instance is configured with a design-time endpoint URL, port, method,
authentication strategy, request parameter keys, and response binding paths.
Runtime logic supplies parameter values and triggers the request through control
pins.

API Outbound Q-SYS Plugin - Features

Core Functionality

Single outbound HTTP endpoint per plugin instance
GET and POST request support
Design-time configuration for URL, port, method, and API key strategy
Manual request trigger from the faceplate and from an input pin

Request Inputs

Up to 8 parameter key definitions configured at design time
Matching runtime ParameterValue pins for request values
Empty parameter values are automatically omitted from the request
GET requests send parameters as query-string values
POST requests send parameters as a JSON object

Inline URL Parameters

{name} placeholders embedded directly in the Request URL
Auto-detected as the URL property changes; matching InlineParam pins are exposed under the URL Params group
Values are URL-encoded before substitution
A request with any unfilled placeholder fails early with a clear error message
Use cases: /devices/{id}/state, /rooms/{room}/sources/{source}, /lights/{zone}/scenes/{scene}

Response Monitoring

Last request URL output
Last request payload output
Last response code output
Last response error output
Full last response body output (top/left aligned, word-wrapped)
Success LED output for the most recent request

Response Mapping

Up to 8 mapped response outputs per instance
JSON path bindings configured at design time
0-based array indexing (result.values[0] is the first element)
Per-binding Found LED outputs to confirm path resolution
String, number, boolean, object, and array values are stringified for output pins

Authentication

No authentication
Bearer token header
X-API-Key header
Custom header name/value pair
Query parameter authentication

User Interface

Tabbed faceplate: API Outbound, Instructions, Device Setup, About
Sectioned reference pages styled consistently with the AchKayEm driver family
Request Parameters and Response Bindings switch to a 2-column layout when more than 4 slots are configured

Licensing and Trial

30-minute fully functional trial period
Activation via license key from the AchKayEm vault
About page licensing panel with product-specific activation link

View all →

Q-SYS API Outbound

Screenshots

Overview

Features