Notify 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 Notify Transformer converts the webhook payload from an external service before you call a Notify API request, which sends the data directly to the user. With the notify transformer, you don’t need a service that translates the webhook payload of the external service into the correct format for the Notify API request. You can handle this conversion in the notify transformer by parsing the payload to return only the necessary values. You can configure the notify transformer in the handleNotify function in the Endpoint settings or via CLI.

Restrictions

• The notify transformer is supported only for webhook- and socket-based Endpoints.

• 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

The following table shows an overview of the function arguments:

Endpoint Configuration Object

endpoint Object Properties

Return Values

The notify transformer returns a valid user ID, session ID, text, and data. These return values need to match the format of the payload of the Endpoint you are using. 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. If the notify transformer returns a falsy value, the output is discarded and not sent to the Notify API request. Here is an example of the correct return format for a webhook-based Endpoint:

handleNotify: async ({ endpoint, request, response }) => {
    const webhookPayload = request.body;

// Parse the webhook payload and extract necessary data
    const userId = webhookPayload.user.id;
    const sessionId = webhookPayload.session.id;
    const text = webhookPayload.message.text;
    const data = {
        source: webhookPayload.source,
        timestamp: webhookPayload.timestamp,
        priority: webhookPayload.priority || 'normal'
    };

return {
        userId,
        sessionId,
        text,
        data
    };
}

Last modified on April 21, 2026.