API

API Triggers fire when a pipeline is called through the REST Data Server. When enabled, they allow consumers to call pipelines for a variety of use cases, including data transformation, extraction, and contextualization. API Triggers can process received values and optionally return generated values.

Configuration

Parameters

Parameters allow users to define the expected payload structure that a pipeline can accept over the REST Data Server. Each parameter includes a name, type, and optional default value. When parameters are defined, incoming requests must include a JSON payload that matches this structure. Parameters without default values must be explicitly provided in the payload. If the payload doesn’t match the defined parameters, the trigger will reject the request, and it won’t be queued for pipeline processing.

If no parameters are defined, the pipeline will accept all incoming payloads. Requests that are of JSON content types will be treated as JSON values, while non-JSON content types will be treated as string values.

If a pipeline has an enabled API Trigger, external consumers can fetch the expected parameters for the pipeline over the REST Data Server. If parameters are defined, they will be returned as a JSON Schema; otherwise, an empty JSON object will be returned. For details on available REST endpoints, refer to the generated Swagger documentation for the REST Data Server.