RudderStack Transformation connects to a Nagent workspace. Once it is connected, agents can call 12 RudderStack Transformation actions, such as "Create Library", "Create Transformation" and "Get library by ID". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against RudderStack Transformation, with input parameters and output schema.
RUDDERSTACK_TRANSFORMATION_CREATE_LIBRARYTool to create a library in RudderStack Transformation. Use when you need to create reusable JavaScript or Python code that can be imported in transformations. Libraries enable code reusability and version maintenance.
Input parameters
The library code.
Name of the library that you wish to create. This name is used as modules when it is imported in the transformation code.
If true, publishes your library to the latest version; code is made live for incoming traffic. Default is false.
Language of the library code. Acceptable values are 'javascript' and 'pythonfaas'.
Description of the library.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_CREATE_TRANSFORMATIONTool to create a RudderStack transformation. When publish=false (default), creates an unpublished transformation not available to event traffic. When publish=true, publishes the transformation making it live for incoming events and connectable to destinations.
Input parameters
The transformation code to execute. For JavaScript, this should export a transformEvent function. For Python, implement the appropriate function signature.
Name of the transformation to create. This is a human-readable identifier for the transformation.
Array of test events (JSON objects) to validate your transformation code. Use this to test your transformation logic before deploying.
Whether to publish the transformation. When false (default), RudderStack creates revisions but the transformation is not available to incoming event traffic. When true, the transformation can be connected to destinations and its code is made live for incoming traffic.
Language of the transformation code. Must be either 'javascript' or 'pythonfaas'.
Description of the transformation. Use this to document what the transformation does.
Array of destination IDs to connect with this transformation. The transformation will apply to events sent to these destinations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_DELETE_TRANSFORMATIONDelete a published transformation by ID. Note that RudderStack never deletes a transformation revision. Use this when you need to remove a transformation from the system.
Input parameters
The unique identifier of the transformation to delete. This is the transformation ID returned when the transformation was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_GET_LIBRARYRetrieves a single published library by its unique identifier. Use when you need to fetch details of a specific library.
Input parameters
The unique identifier of the library to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_GET_LIBRARY_VERSIONTool to retrieve a single library version by library ID and version ID. Use when you need to fetch details of a specific library revision in RudderStack transformations.
Input parameters
The library ID
The version ID of the library
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATIONTool to retrieve a published transformation by its ID from RudderStack. Use when you need to fetch details about a specific transformation including its code, version, and associated destinations.
Input parameters
The unique identifier of the transformation to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATION_VERSIONRetrieve a single transformation revision by transformation ID and version ID. Use when you need to get details about a specific version of a RudderStack transformation.
Input parameters
The transformation ID
The version ID of the transformation
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_LIST_LIBRARIESTool to retrieve all published libraries for a workspace. Use when you need to list available libraries for transformations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_LIST_LIBRARY_VERSIONSTool to get all library revisions for a library ID. Use when you need to retrieve all versions of a specific library in RudderStack Transformation.
Input parameters
The library ID to retrieve versions for
Gets the number of objects in your array. By default always returns the first 5 objects.
Pass either 'asc' for ascending or 'desc' for descending. By default, it sets the order as ascending on createdAt.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATIONSTool to retrieve all published transformations for a workspace. Use when you need to list available transformations or find a specific transformation by name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATION_VERSIONSTool to list all transformation versions (revisions) for a given transformation ID. Use when you need to retrieve the version history of a specific transformation.
Input parameters
The transformation ID for which to retrieve all versions
Gets the number of objects in your array. By default always returns the first 5 objects.
Pass either 'asc' for ascending or 'desc' for descending. By default, it sets the order as ascending on createdAt.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RUDDERSTACK_TRANSFORMATION_UPDATE_TRANSFORMATIONTool to update and optionally publish a RudderStack transformation. Use when you need to modify a transformation's name, description, or code. Updating creates a new revision and sets it as published if the publish flag is true.
Input parameters
The transformation ID to update.
Updated transformation code. Cannot change the language of the transformation code.
Updated transformation name.
If true, publishes the transformation to the latest version. If false or omitted, only creates a new revision without publishing.
Updated transformation description.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 RudderStack Transformation actions on Nagent, including "Create Library", "Create Transformation" and "Get library by ID". Create Library: Create a library in RudderStack Transformation. Each action is listed on this page with its input parameters and its output.
Create Library takes 3 required inputs: code, name and language. It also takes 2 optional inputs: publish and description. It returns data, error and successful.