RudderStack Transformation
rudderstack_transformationRudderStack Transformation API allows you to manage transformations and libraries for customer data pipelines. Use it to create, update, and delete transformations programmatically.
Acciones disponibles (12)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create LibraryRUDDERSTACK_TRANSFORMATION_CREATE_LIBRARYAcciónTool 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.
RUDDERSTACK_TRANSFORMATION_CREATE_LIBRARYAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe library code.
namestringObligatorioName of the library that you wish to create. This name is used as modules when it is imported in the transformation code.
publishbooleanIf true, publishes your library to the latest version; code is made live for incoming traffic. Default is false.
languagestringObligatorioenumLanguage of the library code. Acceptable values are 'javascript' and 'pythonfaas'.
javascriptpythonfaasdescriptionstringDescription of the library.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TransformationRUDDERSTACK_TRANSFORMATION_CREATE_TRANSFORMATIONAcciónTool 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.
RUDDERSTACK_TRANSFORMATION_CREATE_TRANSFORMATIONAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe transformation code to execute. For JavaScript, this should export a transformEvent function. For Python, implement the appropriate function signature.
namestringObligatorioName of the transformation to create. This is a human-readable identifier for the transformation.
eventsobject[]Array of test events (JSON objects) to validate your transformation code. Use this to test your transformation logic before deploying.
publishbooleanWhether 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.
languagestringObligatorioenumLanguage of the transformation code. Must be either 'javascript' or 'pythonfaas'.
javascriptpythonfaasdescriptionstringObligatorioDescription of the transformation. Use this to document what the transformation does.
destination_idsstring[]Array of destination IDs to connect with this transformation. The transformation will apply to events sent to these destinations.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TransformationRUDDERSTACK_TRANSFORMATION_DELETE_TRANSFORMATIONAcciónDelete 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.
RUDDERSTACK_TRANSFORMATION_DELETE_TRANSFORMATIONAcciónDelete 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.
Parámetros de entrada
idstringObligatorioThe unique identifier of the transformation to delete. This is the transformation ID returned when the transformation was created or listed.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get library by IDRUDDERSTACK_TRANSFORMATION_GET_LIBRARYAcciónRetrieves a single published library by its unique identifier. Use when you need to fetch details of a specific library.
RUDDERSTACK_TRANSFORMATION_GET_LIBRARYAcciónRetrieves a single published library by its unique identifier. Use when you need to fetch details of a specific library.
Parámetros de entrada
idstringObligatorioThe unique identifier of the library to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Library VersionRUDDERSTACK_TRANSFORMATION_GET_LIBRARY_VERSIONAcciónTool 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.
RUDDERSTACK_TRANSFORMATION_GET_LIBRARY_VERSIONAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe library ID
versionIdstringObligatorioThe version ID of the library
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TransformationRUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATIONAcciónTool 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.
RUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATIONAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe unique identifier of the transformation to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Transformation VersionRUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATION_VERSIONAcciónRetrieve 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.
RUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATION_VERSIONAcciónRetrieve 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.
Parámetros de entrada
idstringObligatorioThe transformation ID
versionIdstringObligatorioThe version ID of the transformation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All LibrariesRUDDERSTACK_TRANSFORMATION_LIST_LIBRARIESAcciónTool to retrieve all published libraries for a workspace. Use when you need to list available libraries for transformations.
RUDDERSTACK_TRANSFORMATION_LIST_LIBRARIESAcciónTool to retrieve all published libraries for a workspace. Use when you need to list available libraries for transformations.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Library VersionsRUDDERSTACK_TRANSFORMATION_LIST_LIBRARY_VERSIONSAcciónTool to get all library revisions for a library ID. Use when you need to retrieve all versions of a specific library in RudderStack Transformation.
RUDDERSTACK_TRANSFORMATION_LIST_LIBRARY_VERSIONSAcciónTool to get all library revisions for a library ID. Use when you need to retrieve all versions of a specific library in RudderStack Transformation.
Parámetros de entrada
idstringObligatorioThe library ID to retrieve versions for
countintegerGets the number of objects in your array. By default always returns the first 5 objects.
orderBystringPass either 'asc' for ascending or 'desc' for descending. By default, it sets the order as ascending on createdAt.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All TransformationsRUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATIONSAcciónTool to retrieve all published transformations for a workspace. Use when you need to list available transformations or find a specific transformation by name.
RUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATIONSAcciónTool to retrieve all published transformations for a workspace. Use when you need to list available transformations or find a specific transformation by name.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Transformation VersionsRUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATION_VERSIONSAcciónTool to list all transformation versions (revisions) for a given transformation ID. Use when you need to retrieve the version history of a specific transformation.
RUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATION_VERSIONSAcciónTool to list all transformation versions (revisions) for a given transformation ID. Use when you need to retrieve the version history of a specific transformation.
Parámetros de entrada
idstringObligatorioThe transformation ID for which to retrieve all versions
countintegerGets the number of objects in your array. By default always returns the first 5 objects.
orderBystringPass either 'asc' for ascending or 'desc' for descending. By default, it sets the order as ascending on createdAt.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TransformationRUDDERSTACK_TRANSFORMATION_UPDATE_TRANSFORMATIONAcciónTool 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.
RUDDERSTACK_TRANSFORMATION_UPDATE_TRANSFORMATIONAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe transformation ID to update.
codestringUpdated transformation code. Cannot change the language of the transformation code.
namestringUpdated transformation name.
publishbooleanIf true, publishes the transformation to the latest version. If false or omitted, only creates a new revision without publishing.
descriptionstringUpdated transformation description.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not