Skip to main content
The Input Transformer converts the user input after it’s sent to an Endpoint. This allows you to manipulate the user input data before it is sent to the Flow, for example, to communicate with external systems, to implement integrations with a custom channel, and much more. You can configure the input transformer in the handleInput function in the Endpoint settings or via CLI.

​
Restrictions

  • The return value is validated against a set of rules. If these rules aren’t met, the transformer throws an error. The following rules apply:
    • userId is a string with up to 256 characters.
    • sessionId is a string with up to 256 characters.
    • text is a string with up to 10,000 characters.
    • data is an object.

​
Transformer Function Arguments

Depending on the Endpoint type in which you want to use the transformer, the function arguments vary:
  • Webhook- and REST-based Endpoints
  • Socket-based Endpoints
ArgumentDescription
endpointThe configuration object for the Endpoint.
requestThe Express request object with a JSON-parsed body.
responseThe Express response object.

​
Endpoint Configuration Object

PropertyTypeDescription
_idstringThe Endpoint’s Reference ID.
channelstringThe Endpoint’s channel.
URLTokenstringThe URL Token, found in the Input object.
namestringThe Endpoint’s name.
flowIdstringThe Reference ID of the specified Flow to which the Endpoint points to.
entrypointstringThe Entrypoint of the Endpoint.
activebooleanThe flag to activate or deactivate the Endpoint.
nluConnectorIdstringID of the selected NLU connector for the Endpoint.
useAnalyticsbooleanThe flag to collect analytics data for the Endpoint.
storeDataPayloadbooleanThe flag to store data payloads into analytics for the Endpoint.
useConversationsbooleanThe flag to collect conversations history for the Endpoint.
maskIPAddressbooleanThe flag to mask sensitive IP addresses in input object and analytics data.
maskAnalyticsbooleanThe flag to mask sensitive data in analytics for the Endpoint.
maskLoggingbooleanThe flag to mask sensitive data in logs for the Endpoint.
useContactProfilesbooleanThe flag to use Contact Profiles for the Endpoint.
useDashbotAnalyticsbooleanThe flag to use Dashbot for collecting analytics data.
dashbotApikeystringThe API key of the Dashbot bot for analytics collection.
dashbotPlatformstringThe selected platform of the Dashbot bot for analytics collection.
settingsobjectOptional Endpoint-specific settings. For example, Facebook Page token.
handoverSettingsobjectSettings to configure a handover provider.
createdAtnumberUnix timestamp when the Endpoint was created.
lastChangednumberUnix timestamp when the Endpoint was last modified.
createdBystringEmail of the user who created the Endpoint.
lastChangedBystringEmail of the user who last modified the Endpoint.

​
Return Values

The input transformer returns the user ID, session ID, text, and data, which are subsequently sent to the Flow. These values are extracted from the Endpoint payload. The payload format is specific to the Endpoint type you use, for example, Alexa or Facebook (Meta) Messenger. Read the documentation of the specific Endpoint to know how to format the payload. 
return {
    userId: payload.userId,
    sessionId: payload.sessionId,
    text: payload.text,
    data: { "test": 1 }
};

​
Undefined Return Values

If the transformer returns undefined for userId, sessionId, text, or data, this means that the transformer uses the value from the Endpoint.
The following example overwrites text and data, but uses the userId and sessionId from the Endpoint:
return {
    userId: undefined,
    sessionId: undefined,
    text: payload.text,
    data: { "test": 1 }
};

​
Endpoints Event Messages

The Webchat and the Socket.IO Endpoints output event messages that indicate user activity, such as whether the user is connected (user-connected) or disconnected (user-disconnected). These event messages neither trigger Flows nor are counted. The event messages inform handover providers about user activity, allowing human agents to determine if the user is still engaged in the conversation. You can access the event messages with the data._cognigy.event property in the return value of the input transformer. 
return {
    "userId": payload.userId,
    "sessionId": payload.sessionId,
    "text": payload.text,
    "data": {
        "_cognigy": {
              "event": {
                "type": "user-connected"
            }
        }
    }
}
If you want to access event messages in the input transformer, don’t modify them. The event messages are only recognized if their data payload follows a specific format. The following code snippet shows how to use event messages in the input transformer: 
{
handleInput: async ({ payload, endpoint }) => {
  if (!!payload.data?._cognigy?.event) {
// pass on "event messages" without modification
      return payload;
    }

    // rest of your input transformer code
  }
}

​
Transformers and Conversation Counts

Conversations in Cognigy.AI are counted if the input transformer returns any result but falsy.
⌘I