RudderStack Transformation

rudderstack_transformation

RudderStack Transformation API allows you to manage transformations and libraries for customer data pipelines. Use it to create, update, and delete transformations programmatically.

Analytics Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

codestringObligatorio
The library code.
namestringObligatorio
Name of the library that you wish to create. This name is used as modules when it is imported in the transformation code.
publishboolean
If true, publishes your library to the latest version; code is made live for incoming traffic. Default is false.
languagestringObligatorioenum
Language of the library code. Acceptable values are 'javascript' and 'pythonfaas'.
javascriptpythonfaas
descriptionstring
Description of the library.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TransformationRUDDERSTACK_TRANSFORMATION_CREATE_TRANSFORMATIONAcción

Tool 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

codestringObligatorio
The transformation code to execute. For JavaScript, this should export a transformEvent function. For Python, implement the appropriate function signature.
namestringObligatorio
Name 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.
publishboolean
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.
languagestringObligatorioenum
Language of the transformation code. Must be either 'javascript' or 'pythonfaas'.
javascriptpythonfaas
descriptionstringObligatorio
Description 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TransformationRUDDERSTACK_TRANSFORMATION_DELETE_TRANSFORMATIONAcción

Delete 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

idstringObligatorio
The unique identifier of the transformation to delete. This is the transformation ID returned when the transformation was created or listed.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get library by IDRUDDERSTACK_TRANSFORMATION_GET_LIBRARYAcción

Retrieves a single published library by its unique identifier. Use when you need to fetch details of a specific library.

Parámetros de entrada

idstringObligatorio
The unique identifier of the library to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Library VersionRUDDERSTACK_TRANSFORMATION_GET_LIBRARY_VERSIONAcción

Tool 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

idstringObligatorio
The library ID
versionIdstringObligatorio
The version ID of the library

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TransformationRUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATIONAcción

Tool 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

idstringObligatorio
The unique identifier of the transformation to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Transformation VersionRUDDERSTACK_TRANSFORMATION_GET_TRANSFORMATION_VERSIONAcción

Retrieve 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

idstringObligatorio
The transformation ID
versionIdstringObligatorio
The version ID of the transformation

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All LibrariesRUDDERSTACK_TRANSFORMATION_LIST_LIBRARIESAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Library VersionsRUDDERSTACK_TRANSFORMATION_LIST_LIBRARY_VERSIONSAcción

Tool 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

idstringObligatorio
The library ID to retrieve versions for
countinteger
Gets the number of objects in your array. By default always returns the first 5 objects.
orderBystring
Pass either 'asc' for ascending or 'desc' for descending. By default, it sets the order as ascending on createdAt.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List All TransformationsRUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATIONSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Transformation VersionsRUDDERSTACK_TRANSFORMATION_LIST_TRANSFORMATION_VERSIONSAcción

Tool 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

idstringObligatorio
The transformation ID for which to retrieve all versions
countinteger
Gets the number of objects in your array. By default always returns the first 5 objects.
orderBystring
Pass either 'asc' for ascending or 'desc' for descending. By default, it sets the order as ascending on createdAt.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TransformationRUDDERSTACK_TRANSFORMATION_UPDATE_TRANSFORMATIONAcción

Tool 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

idstringObligatorio
The transformation ID to update.
codestring
Updated transformation code. Cannot change the language of the transformation code.
namestring
Updated transformation name.
publishboolean
If true, publishes the transformation to the latest version. If false or omitted, only creates a new revision without publishing.
descriptionstring
Updated transformation description.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not