Output Transformer - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

In Cognigy.AI 2025.25.0, transformers will start using the axios library for handling HTTP requests internally instead of request-promise. This change occurs to improve security and maintainability. The following HTTP request options will still be supported:

• URL configuration — uri, url
• Request method — method
• Request headers and configuration — headers
• Request body — form, json
• Query parameters — qs, qsStringifyOptions
• Authentication — auth
• Connection and network — proxy, maxRedirects, gzip, encoding

If you use other HTTP request options, review your transformer code to ensure it is compatible with the axios library before the release of Cognigy.AI 2025.25.0.

The Output Transformer converts the Flow output. This transformer allows you to manipulate the Flow output before it’s sent to the Endpoint. You can configure the output transformer in the handleOutput function in the Endpoint settings or via CLI. The output transformer works differently for the following Endpoint types:

• REST-based Endpoints
• Webhook- and Socket-based Endpoints

When using output transformers in REST Endpoints, you can’t send multiple Flow outputs to the user. However, you can still have multiple Say Nodes in a Flow that are triggered by each user input. In this case, the handleOutput function stores the Say Node outputs in the outputs array. You can process the stored outputs with the execution finished transformer, which concatenates them into one output when the Flow execution has finished. This approach allows you to manipulate each Flow output in the handleOutput function and then concatenate them into one output with the execution finished transformer.

Transformer Function Arguments

Depending on the Endpoint type you are using, the function arguments vary:

• REST-based Endpoints
• Webhook- and Socket-based Endpoints

Endpoint Configuration Object

Return Values

The output transformer return value depends on the Endpoint type in which you use the transformer. There is no validation of the output transformer return value. If the output transformer returns a falsy value, the output is discarded and not stored in the outputs array.

• REST-based Endpoints
• Webhook- and Socket-based Endpoints

The handleOutput function returns a value and stores it in the outputs array. You can access this array with the handleExecutionFinished function. You can set the format of the outputs array items in the handleOutput function. By default, the outputs array entries have text and data properties. You can change the output format as follows:

Modify the Return Value Format

handleOutput: async ({ processedOutput, output, endpoint, userId, sessionId }) => {
    const modifiedOutput = {
        text: "text",
        data: {}
        // ...
    };
    return modifiedOutput;
}

The output transformer must return a value that can be sent directly to the specific channel. For example, if you’re using the output transformer in a Sunshine Conversations Endpoint, the return value format must meet the Sunshine Conversations message format.

Format Example for Sunshine Conversations Endpoints

handleOutput: async ({ processedOutput, output, endpoint, userId, sessionId }) => {
    const requestPayload = {
        author: {
            type: "business"
        },
        content: {
            type: "text",
            text: "Hello world"
        }
    };
    return requestPayload;
}