Skip to main content
Turbot Pipes logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 170
  • Triggers: 0
  • Slug: TURBOT_PIPES
  • Version: 20261101_00

Tools

Slug: TURBOT_PIPES_ACTOR_GETTool to retrieve the authenticated actor. Use when you need details about the currently authenticated actor after obtaining a valid token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_ACTOR_LIST_ACTIVITYTool to list activities for the authenticated actor. Use when you need detailed activity logs with optional filtering and pagination.

Input Parameters

integer
Maximum number of activity records to return.
string
Query to filter actor activities (e.g., ‘action_type=token.create’).
string
Token for fetching the next page of results (from previous response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_ACTOR_LIST_CONNECTIONSTool to list connections associated with the authenticated actor. Use after confirming authentication to retrieve the actor’s connection list.

Input Parameters

string
Filter by connection type
integer
Maximum number of results to return, must be >=1
integer
Pagination offset, must be >=0
string
Filter by actor ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_ACTOR_LIST_ORGSTool to list organizations associated with the authenticated actor. Use when you have a valid access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_ACTOR_LIST_WORKSPACESTool to list workspaces for the authenticated actor. Use when you need to retrieve all workspaces the actor has access to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_AUTH_LOGIN_TOKEN_EMAIL_CREATETool to start login process by sending a confirmation code to a user’s email. Use when initiating a passwordless email login flow.

Input Parameters

string
required
User’s email address to receive the login confirmation code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_AUTH_SIGNUPTool to create a new user account via signup. Use when registering a new user with their email address.

Input Parameters

string
required
User’s email address for account signup
string
Optional state parameter for maintaining state across the signup flow

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_CONNECTIONTool to create a new connection for an organization. Use when you need to establish a new connection with a specific plugin (e.g., AWS, GCP, Azure) in an organization.

Input Parameters

string ("available")
Mode of the request for creating org connection.
object
The plugin or connection configuration
string
required
The handle name for the connection. Must match pattern ^a-z){0,38}$
string
required
The plugin name for the connection
string
The id of the entity where the connection is stored. Can be either tenant, identity, workspace or connection-folder
string
required
The handle of the organization where the connection will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_CONNECTION_FOLDERTool to create a new connection folder for an organization. Use when you need to create a connection folder in an org to organize connections.

Input Parameters

string ("available")
Mode enum for the request.
string
required
The title of the connection folder. Must match pattern: ^a-z){0,38}$
string
The id of the parent entity where the connection folder will be created.
string
required
The handle of the org for which we want to create a connection folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_WORKSPACE_AGGREGATORTool to create an aggregator for a workspace of an organization. Use when you need to add a new aggregator to a specific organization’s workspace.

Input Parameters

object
The configuration for the aggregator
string
required
The handle of the aggregator. Must start with a lowercase letter, followed by lowercase letters, numbers, or underscores, up to 39 characters total
string
required
Plugin name for the aggregator (e.g., ‘aws’, ‘gcp’, ‘azure’)
string
required
The handle of the organization to which the workspace belongs
array
The connections that are a part of the aggregator
string
required
The handle of the workspace where the aggregator will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_WORKSPACE_CONNECTIONTool to create a connection on an org workspace or associate an existing org connection to the workspace. Use when you need to create or link a connection to an organization’s workspace.

Input Parameters

object
The plugin or connection configuration
string
required
The handle for the connection. Must match pattern: ^a-z){0,38}$
string
required
The plugin name for the connection
string
The id of the parent entity where the connection will be stored
string
required
The handle of the organization to which the workspace belongs to
string
required
The handle of the workspace where the connection will be created or associated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_WORKSPACE_CONNECTION_FOLDERTool to create a connection folder in a workspace of an organization. Use when you need to organize connections into folders within an org workspace.

Input Parameters

string ("available")
Mode for the request.
string
required
The title of the connection folder. Must start with a lowercase letter, followed by lowercase letters, numbers, or underscores, up to 39 characters total
string
The ID of the parent folder where this connection folder will be created
string
required
The handle of the organization where the connection folder will be created
string
required
The handle of the workspace where the connection folder will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_WORKSPACE_QUERYTool to execute a SQL query in an org workspace using POST method. Use when you need to run queries against Turbot Pipes workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

Input Parameters

string
required
SQL query to execute against the workspace. Results are limited to 5000 rows or 30 seconds of query execution
string
required
The handle of the organization
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_ORG_WORKSPACE_SNAPSHOTCreate an organization workspace snapshot from supplied snapshot data, including its time range, layout and panels. Optional title, tags and visibility can be supplied.

Input Parameters

object
required
The snapshot data containing layout, panels, and time range information.
object
Optional tags to categorize or label the snapshot.
string
Optional title for the snapshot.
string
required
The handle of the organization where the workspace exists.
string ("workspace" | "anyone_with_link")
Visibility options for workspace snapshots.
string
required
The handle of the workspace to create the snapshot for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_AI_KEYTool to create a new AI provider API key at the user level. Use when you need to configure AI provider credentials for a specific user in Turbot Pipes.

Input Parameters

string
required
The API key from the AI provider (e.g., OpenAI or Anthropic)
string ("openai" | "anthropic")
required
The AI provider for this API key
string
required
The handle of the user for which the AI key is being created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_CONNECTIONTool to create a new connection for a user. Use when you need to establish a new connection with a specific plugin (e.g., AWS, GCP, Azure) for a user account.

Input Parameters

string ("available")
Mode of the request for creating user connection.
object
The plugin or connection configuration
string
required
The handle name for the connection. Must match pattern ^a-z){0,38}$
string
required
The plugin name for the connection
string
The id of the entity where the connection is stored. Can be either tenant, identity, workspace or connection-folder
string
required
The handle of the user where we want to create the connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_INTEGRATIONTool to create a new integration for a user. Use when you need to create a new integration for a specific user by providing the user handle, integration handle, and type.

Input Parameters

string ("aws" | "azure" | "gcp" | "github" | "slack" | "gitlab")
required
The type of the integration, can be one of aws, azure, gcp, gitlab, slack or github
object
The configuration for the integration
string
required
The handle for the integration
string
required
The handle of the user for which you want to create an integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_NOTIFIERTool to create a new notifier for a user. Use when you need to configure notification endpoints for a specific user in Turbot Pipes.

Input Parameters

string
required
The name of the notifier to create. Must match pattern: ^a-z){0,38}$ (lowercase letters, numbers, underscores, max 39 chars)
string ("enabled" | "disabled")
required
The state of the notifier (enabled or disabled)
array
required
List of notify targets for the notifier. Each target specifies an integration handle and type
string
required
The handle of the user for which the notifier is being created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_PASSWORDTool to create or rotate a user password. Use when you need to generate a new password for a user or reset an existing one.

Input Parameters

string
required
Handle of the user whose password needs to be created or rotated
integer
Number of minutes until the password expires. If not specified, password may not expire or uses system default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_WORKSPACE_CONNECTIONCreate a connection in a user’s workspace using a connection handle and plugin, with optional configuration and parent.

Input Parameters

object
The plugin or connection configuration
string
required
The handle for the connection. Must match pattern: ^[a-z0-9][a-z0-9-]{1,37}[a-z0-9]$
string
required
The plugin name for the connection
string
The id of the parent entity where the connection will be stored
string
required
The handle of the user who owns the workspace
string
required
The handle of the workspace where the connection will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_WORKSPACE_CONNECTION_FOLDERTool to create a connection folder in a workspace of a user. Use when you need to organize connections into folders within a user workspace.

Input Parameters

string
required
The title of the connection folder. Must start with a lowercase letter, followed by lowercase letters, numbers, or underscores, up to 39 characters total
string
The ID of the parent folder where this connection folder will be created
string
required
The handle of the user where the connection folder will be created
string
required
The handle of the workspace where the connection folder will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_WORKSPACE_DATATANKTool to create a new user workspace Datatank. Use when you need to create a new Datatank for data storage in a user’s workspace.

Input Parameters

string
required
The handle name for the datatank. Must match pattern ^[A-Za-z_][A-Za-z_0-9$]*$
string
Description of the datatank.
string
required
The handle of the user where we want to create the workspace Datatank.
string ("enabled" | "disabled")
Desired state for the datatank.
string
required
The handle of the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_WORKSPACE_DATATANK_TABLETool to create a new user workspace datatank table. Use when you need to create a table within a user’s workspace datatank for data storage and querying.

Input Parameters

string
required
The name of the table. Must match pattern ^[A-Za-z_][A-Za-z_0-9$]*$
string ("table" | "query")
required
The type of the table, either ‘table’ or ‘query’.
string ("connection")
Partition strategy for the datatank table.
object
required
The frequency configuration for refreshing the table.
string
Description of the datatank table.
string
required
The handle of the user where we want to create the workspace Datatank table.
string
The SQL query to populate the table. Required when type is ‘query’.
string
The source table name. Used when type is ‘table’.
string ("enabled" | "disabled")
Desired state of the datatank table.
string
The source schema name. Used when type is ‘table’.
string
required
The name of the Datatank.
string
required
The handle of the workspace.
boolean
Whether to skip the initial refresh of the table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_WORKSPACE_MOD_VARIABLE_SETTINGTool to create a setting for a mod variable in a user workspace. Use when you need to configure a variable for a mod installed in a user’s workspace.

Input Parameters

string
required
The name of the variable to create the setting for
string
required
The setting value for the variable (can be string, number, boolean, object, or array)
string
required
The mod alias or mod ID for which the variable setting is to be created
string
required
The handle of the user who owns the workspace
string
required
The handle of the workspace where the mod is installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_CREATE_USER_WORKSPACE_NOTIFIERTool to create a new notifier for a user workspace. Use when you need to configure a notification endpoint (e.g., Slack, email) for a specific workspace.

Input Parameters

string
required
The name of the notifier to create. Must start with a lowercase letter, followed by lowercase alphanumeric characters or underscores (max 39 characters)
string ("enabled" | "disabled")
State of the notifier.
array
required
The notify targets for the notifier to create
string
required
The handle of the user for which the notifier is to be created
string
required
The handle of the workspace for which the notifier is to be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_CONVERSATION_ORGTool to delete a specific org workspace conversation. Use when you need to remove an AI conversation from an organization workspace after confirming the org handle, workspace handle, and conversation ID.

Input Parameters

string
required
The handle of the organization that owns the workspace
string
required
The ID of the conversation to delete
string
required
The handle of the org workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_ORGTool to delete a specified organization if you have appropriate access. Use when you need to permanently remove an organization and have confirmed the org handle.

Input Parameters

string
required
Specify the handle of the organization which need to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_ORG_BILLING_SUBSCRIPTIONTool to delete an organization billing subscription. Schedules cancellation at the end of the current period. Use when you need to cancel an org subscription after confirming the org handle and subscription ID.

Input Parameters

string
required
The handle of the organization whose subscription will be deleted
string
required
The org subscription id to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_ORG_CONNECTION_PERMISSIONDelete a specific permission from an organization connection. On a 204 response, the returned record contains the requested permission ID and placeholder metadata rather than permission details.

Input Parameters

string
required
The handle of the org for which we want to delete connection permission for
string
required
The id of the permission which we want to delete
string
required
The handle of the connection for which we want to delete permission for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_ORG_WORKSPACETool to delete an organization workspace. Use when you need to permanently remove a workspace from an organization after confirming org and workspace handles.

Input Parameters

string
required
The handle of the organization where the workspace exists
string
required
The handle of the workspace to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_ORG_WORKSPACE_MOD_VARIABLE_SETTINGTool to delete setting for a mod variable in an organization workspace. Use when you need to remove a custom setting for a mod variable in a specific workspace.

Input Parameters

string
required
The mod alias or mod ID which contains the variable
string
required
The handle of the organization that owns the workspace
string
required
The name of the variable to delete the setting for
string
required
The handle of the workspace where the mod was installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_USER_AVATARTool to delete custom avatar for a user. Use when you need to remove a user’s custom avatar and revert to default.

Input Parameters

string
required
Handle or identifier of the user whose avatar will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_USER_CONNECTION_DEPRECATEDDelete a user’s connection by user handle and connection handle using the deprecated endpoint. The response may include deleted connection details.

Input Parameters

string
required
The handle of the connection that needs to be deleted
string
required
The handle of the user where the connection exists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_USER_INTEGRATIONTool to delete an integration configured for a user. Use when you need to remove a user’s integration by providing the user handle and integration handle.

Input Parameters

string
required
The handle identifying the user whose integration is configured
string
required
The handle identifying the integration to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_USER_WORKSPACE_MOD_VARIABLE_SETTINGTool to delete a mod variable setting in a user workspace. Use when you need to remove a variable configuration from a mod installed in a user’s workspace.

Input Parameters

string
required
The mod alias or mod ID for which the variable setting is to be deleted
string
required
The handle of the user who owns the workspace
string
required
The name of the variable to delete the setting for
string
required
The handle of the workspace where the mod was installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_USER_WORKSPACE_NOTIFIERTool to delete a notifier for a user workspace. Use when you need to remove a notification configuration from a specific workspace.

Input Parameters

string
required
The handle of the user for which the notifier is to be deleted
string
required
The name of the notifier to be deleted
string
required
The handle of the workspace for which the notifier is to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_DELETE_USER_WORKSPACE_PIPELINETool to delete a pipeline from a user’s workspace. Use when you need to remove a specific pipeline by its ID from a workspace.

Input Parameters

string
required
Provide the id of the pipeline which needs to be deleted.
string
required
The handle of the user which contains the workspace.
string
required
The handle of the workspace where the pipeline exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_AUTH_PROVIDERTool to initiate OAuth authentication flow with a provider. Use when you need to start the OAuth authorization process for GitHub, Google, or SAML authentication.

Input Parameters

string ("github" | "google" | "saml")
required
Authentication provider name (github, google, or saml). This will initiate an OAuth authorization flow with the specified provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_CONVERSATION_USERTool to retrieve details for a specific user workspace conversation. Use when you need to get information about an AI conversation in a user workspace.

Input Parameters

string
required
The handle of the user that owns the workspace
string
required
The ID of the conversation to retrieve
string
required
The handle of the user workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_DATATANK_TABLETool to get the details for a workspace Datatank table. Use when you need to retrieve information about a specific datatank table including its state, configuration, and metadata.

Input Parameters

string
required
The handle of the organization or user (identity handle)
string
required
The handle of the datatank
string
required
The handle of the workspace
string
required
The name of the datatank table

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORGTool to retrieve organization information by handle. Use when you need details about a specific organization.

Input Parameters

string
required
Specify the handle of an organization whose information you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_BILLING_INVOICETool to get an invoice for an organization. Use when you need to retrieve detailed billing invoice information for a specific organization and invoice ID.

Input Parameters

string
required
The unique identifier of the invoice (Stripe invoice ID format)
string
required
The handle of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_CONNECTION_PERMISSIONTool to retrieve permission details for an org connection. Use when you need to view a specific permission record for a connection within an organization.

Input Parameters

string
required
The handle of the org for which to get connection permission.
string
required
The ID of the permission to retrieve.
string
required
The handle of the connection for which to get permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_INTEGRATIONTool to get details of an integration configured on an organization. Use when you need to retrieve information about a specific integration by its handle and organization handle.

Input Parameters

string
required
The handle of the org to which the integration belongs to.
string
required
The handle of the integration whose details need to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_MEMBERTool to retrieve a specific organization member by org handle and user handle. Use when you need details about a specific member of an organization.

Input Parameters

string
required
The handle of the organization
string
required
The handle of the user/member to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_CONNECTIONTool to get the details for a workspace and connection association on an organization. Use when you need to retrieve information about how a connection is associated with a specific workspace in an organization.

Input Parameters

string
required
The handle of the org for which you want to get the association
string
required
The handle of the workspace where the connection exists
string
required
The handle of the connection whose association details needs to be fetched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_CONNECTION_FOLDERTool to retrieve a connection folder for an organization workspace. Use when you need to get details about a specific connection folder in an org workspace.

Input Parameters

string
required
The id of the connection folder to retrieve.
string
required
The handle of the organization where the folder exists.
string
required
The handle of the workspace where the folder exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_FLOWPIPE_TRIGGERTool to get the details of a trigger for a workspace in an organization. Use when you need to retrieve information about a specific Flowpipe trigger.

Input Parameters

string
required
The handle of the organization which contains the workspace.
string
required
The name of the flowpipe trigger whose details needs to be fetched.
string
required
The handle of the workspace where the trigger exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_INTEGRATIONTool to get details of an integration available for a workspace belonging to an organization. Use when you need to retrieve information about a specific integration configured for a workspace within an organization.

Input Parameters

string
required
The handle of the organization to which the workspace belongs
string
required
The handle of the workspace for which you want to get integration details
string
required
The handle of the integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_MOD_VARIABLE_SETTINGTool to get setting for a mod variable in an organization workspace. Use when you need to retrieve the current configuration and value of a specific mod variable in a workspace.

Input Parameters

string
required
The mod alias or mod ID which contains the variable
string
required
The handle of the organization that owns the workspace
string
required
The name of the variable to retrieve the setting for
string
required
The handle of the workspace where the mod is installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_NOTIFIERTool to retrieve a notifier from an org workspace. Use when you need to get details about a specific notification endpoint configured for an organization’s workspace.

Input Parameters

string
required
Handle of the organization
string
required
Name of the notifier to retrieve
string
required
Handle of the workspace within the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_ORG_WORKSPACE_QUERY_DATATool to execute a SQL query in an org workspace and retrieve results. Use when you need to run queries against Turbot Pipes workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

Input Parameters

string
required
SQL query to execute against the workspace. Results are limited to 5000 rows or 30 seconds of query execution
string ("json" | "csv" | "md")
required
Output format extension - determines response content type (json, csv, or md)
string
required
The handle of the organization
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_TENANTTool to retrieve tenant information by handle. Use when you need details about a specific tenant.

Input Parameters

string
required
Specify the handle of a tenant whose information you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_TENANT_AVATARTool to retrieve public avatar image for a tenant. Use when you need to display or download the tenant’s avatar.

Input Parameters

string
required
The handle of the tenant to retrieve the avatar for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USERTool to retrieve user information by handle. Use when you need details about a specific user.

Input Parameters

string
required
Specify the handle of the user whose information you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_AI_KEYTool to retrieve AI provider API key metadata at the user level. Use when you need to check which AI provider keys are configured for a specific user.

Input Parameters

string ("openai" | "anthropic")
required
AI provider for which to retrieve the key (openai or anthropic)
string
required
Handle of the user that owns the AI key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_BILLING_PLANTool to get the current user billing plan. Use when you need to retrieve detailed billing plan information for a specific user.

Input Parameters

string
required
The handle of the user whose billing plan to retrieve. Can be obtained from the GET /actor endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_BILLING_UPCOMING_INVOICEGet the upcoming invoice for a user to review the estimated next invoice for their billing cycle.

Input Parameters

string
required
The handle of the user to retrieve the upcoming invoice for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_CONNECTIONTool to retrieve details of a connection belonging to a user. Use when you need to fetch information about a specific user connection by user handle and connection handle.

Input Parameters

string
required
The handle of the user who owns the connection
string
required
The handle of the connection to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_EMAILTool to retrieve a specific user email record with metadata. Use when you need details about a user’s email verification status and metadata.

Input Parameters

string
required
Specify the id of the email object you want to retrieve.
string
required
Specify the handle of the user whose email information you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_INTEGRATIONTool to get details of an integration configured on a user. Use when you need to retrieve information about a specific user integration by providing the user handle and integration handle.

Input Parameters

string
required
The handle of the user to which the integration belongs to.
string
required
The handle of the integration whose details need to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_PASSWORDTool to retrieve user database password. Use when you need to get the database password for a specific user by their handle.

Input Parameters

string
required
Specify the handle of the user whose password need to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_PREFERENCESTool to retrieve user preferences including email subscription settings. Use when you need to check a user’s communication preferences.

Input Parameters

string
required
Specify the handle of the user whose preferences need to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_PROCESSTool to retrieve process information for a user. Use when you need details about a specific process associated with a user.

Input Parameters

string
required
The unique identifier of the process to retrieve.
string
required
The handle of the user whose process you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACETool to retrieve workspace details for a specific user. Use when you need information about a workspace owned by a user.

Input Parameters

string
required
The handle of the user where the workspace exists.
string
required
The handle of the workspace whose details need to be fetched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_AGGREGATORTool to get the details of an aggregator belonging to a workspace of a user. Use when you need to retrieve information about a specific aggregator in a user’s workspace.

Input Parameters

string
required
The handle of the user to which the workspace belongs
string
required
The handle of the workspace where the aggregator exists
string
required
The handle of the aggregator to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_CONNECTIONTool to get the details for a workspace and connection association for a user. Use when you need to retrieve information about how a connection is associated with a specific workspace owned by a user.

Input Parameters

string
required
The handle of the user for which you want to get the association
string
required
The handle of the workspace where the association exists
string
required
The handle of the connection whose association details needs to be fetched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_CONNECTION_FOLDERTool to retrieve a connection folder for a user workspace. Use when you need to get details about a specific connection folder in a user workspace.

Input Parameters

string
required
The id of the connection folder to retrieve.
string
required
The handle of the user where the folder exists.
string
required
The handle of the workspace where the folder exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_DATATANKTool to retrieve user workspace datatank details. Use when you need information about a specific datatank within a user’s workspace.

Input Parameters

string
required
The handle of the user.
string
required
The name of the workspace Datatank.
string
required
The handle of the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_FLOWPIPE_MODTool to retrieve details of an installed flowpipe mod in a user workspace. Use when you need information about a specific flowpipe mod installed in a workspace.

Input Parameters

string
required
The mod alias or mod ID
string
required
The handle of the user who owns the workspace.
string
required
Provide the handle of the workspace where mod was installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_FLOWPIPE_PIPELINETool to retrieve pipeline details for a user workspace. Use when you need detailed information about a specific Flowpipe pipeline in a user’s workspace.

Input Parameters

string
required
The id of the pipeline whose detail needs to be fetched.
string
required
The handle of the user which contains the workspace.
string
required
The handle of the workspace where the pipeline exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_INTEGRATIONTool to get details of an integration available for a workspace belonging to a user. Use when you need to retrieve information about a specific integration configured for a user’s workspace.

Input Parameters

string
required
The handle of the user to which the workspace belongs to.
string
required
The handle of the workspace for which we want to get the integration details.
string
required
The handle of the integration whose details need to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_MODTool to retrieve details of an installed mod in a user’s workspace. Use when you need information about a specific mod installed in a workspace owned by a user.

Input Parameters

string
required
The mod alias or mod ID to retrieve.
string
required
The handle of the user who owns the workspace.
string
required
The handle of the workspace where the mod is installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_MOD_VARIABLE_SETTINGTool to get setting for a mod variable in a user workspace. Use when you need to retrieve the current configuration and value of a specific mod variable in a user’s workspace.

Input Parameters

string
required
The mod alias or mod ID for which the variable setting belongs to
string
required
The handle of the user who owns the workspace
string
required
The name of the variable to get the setting for
string
required
The handle of the workspace where the mod was installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_NOTIFIERTool to retrieve a notifier from a user workspace. Use when you need to get details about a specific notification endpoint configured for a user’s workspace.

Input Parameters

string
required
The handle of the user for which the notifier is to be retrieved.
string
required
The name of the notifier to be retrieved.
string
required
The handle of the workspace for which the notifier is to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_PIPELINETool to get the details of a pipeline for a workspace of a user. Use when you need information about a specific pipeline in a user workspace.

Input Parameters

string
required
The unique identifier of the pipeline to retrieve.
string
required
The handle of the user where the workspace exists.
string
required
The handle of the workspace where the pipeline exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_PROCESSTool to retrieve process details for a user workspace. Use when you need information about a specific process running in a user’s workspace.

Input Parameters

string
required
The unique identifier of the process to be fetched.
string
required
The handle of the user where the workspace exists.
string
required
The handle of the workspace whose process needs to be fetched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_PROCESS_LOGTool to retrieve process logs for a user workspace process. Use when you need to fetch and analyze logs for a specific process running in a user’s workspace.

Input Parameters

string ("process")
required
The process log file to fetch (currently only ‘process’ is supported)
string
required
The unique identifier of the process
string
required
The handle of the user where the workspace exists
string ("jsonl")
required
The content type format for the log file (currently only ‘jsonl’ is supported)
string
required
The handle of the workspace where the process is running

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_QUERYTool to execute a SQL query in a user workspace and retrieve results. Use when you need to run queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

Input Parameters

string
required
The SQL query to execute against the workspace. Results are limited to 5000 rows or 30 seconds of query execution
string
required
The handle of the user
string ("application/json" | "text/csv" | "text/markdown")
Supported content types for query response format.
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_QUERY_DATATool to execute a SQL query in a user workspace and retrieve results. Use when you need to run queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

Input Parameters

string
required
SQL query to execute against the workspace. Results are limited to 5000 rows or 30 seconds of query execution
string ("json" | "csv" | "md")
required
Output format extension - determines response content type (json, csv, or md)
string
required
The handle of the user
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_SCHEMATool to retrieve workspace schema details for a specific user. Use when you need information about a specific schema within a user’s workspace.

Input Parameters

string
required
The name of the schema whose detail needs to be fetched
string
required
The handle of the user that the workspace belongs to
string
required
The handle of the workspace where the schema exists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_GET_USER_WORKSPACE_SCHEMA_TABLETool to get details about a specific table in a user workspace schema. Use when you need information about table structure, columns, and metadata within a user’s workspace schema.

Input Parameters

string
required
The name of the table whose detail needs to be fetched.
string
required
The name of the schema to which the table belongs.
string
required
The handle of the user that the workspace belongs to.
string
required
The handle of the workspace where the schema exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_IDENTITIES_GETTool to retrieve a specific identity by handle. Use when you need details of an identity by its handle after authenticating.

Input Parameters

string
required
Unique identifier for the identity to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_IDENTITIES_GET_AVATARTool to retrieve avatar image for an identity. Use when you need to display or download the user’s avatar after knowing their identity handle.

Input Parameters

string
required
Handle or ID of the identity for which to retrieve the avatar image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_IDENTITIES_LISTList identities with optional search filtering and pagination after authentication.

Input Parameters

string
Search query to filter identities by display name or handle.
integer
Maximum number of identities to return per page (1-100).
string
Token for pagination to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_INITIATE_LOGINTool to initiate user login. Use when starting a login flow for a user with their email address.

Input Parameters

string
required
User’s email address to initiate login
string
Optional state parameter for maintaining state across the login flow

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_INSTALL_USER_INTEGRATION_SLACKInitiate Slack integration installation for a user identity. When the service returns a 307 redirect, return the Slack authorization URL for the user to visit.

Input Parameters

string
required
The handle of the user to which the integration belongs to.
string
required
The handle of the Slack integration which needs to be installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_INSTALL_USER_WORKSPACE_FLOWPIPE_MODTool to install a flowpipe mod to a user’s workspace. Use when you need to install a flowpipe mod from a repository path into a specific user workspace.

Input Parameters

string
required
The path to the flowpipe mod (e.g., github.com/turbot/flowpipe-mod-aws)
string
Git branch to install from
string
Specific version to install
string
Version constraint for the mod (e.g., ‘^1.0.0’, ’*’, ‘latest’)
string
required
The handle of the user who owns the workspace
string
required
The handle of the workspace where the mod will be installed
string
Handle of the integration to use for authentication

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_INSTALL_USER_WORKSPACE_MODTool to install a mod to a user workspace. Use when you need to add a new mod from a repository path to a specific workspace.

Input Parameters

string
required
The path to the mod repository (e.g., github.com/turbot/steampipe-mod-azure-compliance).
string
required
The handle of the user who owns the workspace.
string
required
The handle of the workspace where the mod will be installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_PROCESSTool to list processes for an organization. Use when you need to retrieve all processes for a specific organization with optional pagination.

Input Parameters

integer
Maximum number of processes to return per page (1-100).
string
Token for pagination to retrieve the next page of results.
string
required
The handle of the organization to list processes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_SERVICE_ACCOUNTSList service accounts for an organization, one page at a time. Use the returned next token to retrieve subsequent pages.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_USAGEList an organization’s usage metrics for billing, monitoring, or analytics, one page at a time. Use the returned next token to retrieve subsequent pages.

Input Parameters

integer
Maximum number of usage records to return per page
string
Token for fetching the next page of results (from previous response)
string
required
The handle of the organization whose usage metrics you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_WORKSPACE_DATATANKTool to list org workspace Datatank with pagination support. Use when you need to retrieve Datatank items for a specific organization and workspace.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the org for which we want to list the workspace Datatank.
string
required
The handle of the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_WORKSPACE_FLOWPIPE_MOD_VARIABLEList variables for a Flowpipe mod in an organization workspace, one page at a time. Use the returned next token to retrieve subsequent pages.

Input Parameters

integer
Maximum items per page (1-100 range). If not specified will default to 25.
string
required
The mod alias or mod ID for which we want the variables to be listed
string
Pagination cursor for fetching subsequent pages. When list results are truncated, next_token will be returned to fetch the next page of data.
string
required
The handle of the organization that owns the workspace
string
required
The handle of the workspace where the mod was installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_WORKSPACE_MODTool to list organization workspace installed mods with pagination support. Use when you need to retrieve installed mods for a specific organization and workspace.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of an organization that owns the workspace.
string
required
The handle of the workspace where mods were installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_WORKSPACE_PIPELINEList pipelines for an organization workspace, with optional filtering and pagination. A 404 response is returned as an empty list.

Input Parameters

integer
Maximum number of items to fetch per page (1-100). Defaults to 25 if not specified.
string
SQL where filter to apply to this request. The filter will be parsed, sanitised and checked against supported columns.
string
Pagination cursor returned from previous request to fetch the next page of results.
string
required
The handle of the organization which contains the workspace.
string
required
The handle of the workspace for which to list the pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_WORKSPACE_PROCESSTool to list processes associated with an org workspace. Use when you need to retrieve all processes for a specific organization workspace with optional filtering and pagination.

Input Parameters

integer
Maximum items per page (1-100, default: 25).
string
SQL filter clause for request filtering, sanitized against supported columns.
string
Pagination cursor for fetching subsequent data pages.
string
required
The handle of an organization for which you want to list the processes.
string
required
The handle of the workspace where you want to list the processes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_ORG_WORKSPACESList workspaces for an organization, with pagination support. Use the returned next token to retrieve additional pages.

Input Parameters

integer
Maximum number of workspaces to fetch per page (1-100). Defaults to 25 if not specified.
string
Pagination cursor returned from previous request to fetch the next page of results.
string
required
The handle of the organization for which to list workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_TENANT_GETSETTINGSTool to retrieve tenant settings. Use when you need to view the current configuration for the tenant, including login methods, session timeouts, and user provisioning settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_TENANTSTool to list tenants the actor is a member of. Use when you need to retrieve all tenants associated with the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_AI_KEYSTool to list AI provider API keys configured at the user level. Use when you need to retrieve all AI keys for a specific user.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data.
string
required
The handle of the user for which to list AI keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_AUDIT_LOGSTool to list audit logs for a specific user. Use when you need to retrieve audit trail information with optional pagination.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. Defaults to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user whose audit logs to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_BILLING_INVOICESTool to list user invoices with pagination support. Use when you need to retrieve billing invoice information for a specific user.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user to list invoices for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_BILLING_PAYMENT_METHODTool to list user billing payment methods. Use when you need to retrieve payment methods configured for a user’s billing.

Input Parameters

integer
Max items per page. Default: 25, max: 100.
string
Cursor for next page.
string
required
The handle of the user to list the payment methods for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_BILLING_SUBSCRIPTIONTool to list user billing subscriptions. Use when you need to retrieve subscription information for a specific user. Note: Users typically have one active subscription, but this endpoint may also return historical subscriptions.

Input Parameters

integer
Max items per page. Default: 25, max: 100.
string
Cursor for next page.
string
required
The handle of the user to retrieve the subscriptions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_CONNECTIONSTool to list connections for a specific user by user handle. Use when you need to retrieve all connections associated with a user.

Input Parameters

integer
Max items per page. Default: 25, max: 100.
string
Cursor for next page.
string
required
The handle of the user whose connections to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_CONSTRAINTSTool to list all applicable constraints for a user. Use when you need to retrieve quota, rate, or setting constraints with optional filtering and pagination.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
Specify the handle of the user whose constraints you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_EMAILSList a page of email addresses and associated metadata for a specific user. Use the returned next token to request further pages.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
Specify the handle of the user whose information you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_INTEGRATIONList integrations configured for a user, returning one page at a time. Use the returned next token to request further pages.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user to which the integration belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_PROCESSList processes for a specific user, returning one page at a time. Use the returned next token to request further pages.

Input Parameters

integer
Maximum number of processes to return per page (1-100). Defaults to 25.
string
Token for pagination to retrieve the next page of results.
string
required
The handle of the user to list processes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_USAGEList a page of usage metrics for a user, optionally filtered and paginated, for billing, monitoring, or analytics.

Input Parameters

integer
Maximum number of usage records to return per page (1-100, default 25)
string
SQL where filter to apply to the request for filtering usage records
string
Cursor for pagination to fetch the next page of results (from previous response)
string
required
The handle of the user whose usage metrics you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_AGGREGATORTool to list aggregators for a workspace of a user. Use when you need to retrieve aggregator configurations for a specific user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user to which the workspace belongs to.
string
required
The handle of the workspace for which we will be listing aggregators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_AGGREGATOR_CONNECTIONSList a page of connections in a specific aggregator in a user workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100. Defaults to 25 if not specified.
string
Pagination cursor for fetching subsequent pages when results are truncated
string
required
The handle of the user to which the workspace belongs
string
required
The handle of the workspace where the aggregator exists
string
required
The handle of the aggregator whose connections need to be fetched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_AUDIT_LOGSTool to list audit logs for a specific user workspace. Use when you need to retrieve workspace audit trail information with optional pagination.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. Defaults to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user who owns the workspace
string
required
The handle of the workspace whose audit logs to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_CONNECTIONList a page of connections explicitly defined or associated with a user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_CONNECTION_ASSOCIATIONList a page of connection associations for a user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_CONNECTION_FOLDERList a page of connection folders for a user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user where the connection folders exist.
string
required
The handle of the workspace where the connection folders exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_CONNECTION_TREETool to list connection tree for a user workspace. Use when you need to retrieve the hierarchical connection structure for a specific user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
The SQL where filter you wish to apply to this request.
string
The prefix to be used when listing items in a connection tree.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user to which the workspace belongs.
string
required
The handle of the workspace for which we want to retrieve the connection tree.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_CONVERSATIONSTool to list AI conversations in a user workspace with optional filtering and pagination. Use when you need to retrieve conversations from a specific user workspace, optionally filtered by title pattern.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25
string
Optional filter expression for title. Use to filter conversations by title matching a specific pattern
string
When list results are truncated, next_token will be returned. Pass next_token to fetch the next page of data
string
required
The handle of the user that owns the workspace
string
required
The handle of the user workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_DATATANKTool to list user workspace Datatank with pagination support. Use when you need to retrieve Datatank items for a specific user and workspace.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user for which we want to list the workspace Datatank.
string
required
The handle of the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_DATATANK_PARTTool to list user workspace Datatank partitions with pagination support. Use when you need to retrieve partition details for a specific Datatank table in a user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user for which we want to list the workspace Datatank.
string
required
The name of the Datatank.
string
required
The handle of the workspace.
string
required
The name of the workspace Datatank table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_DATATANK_TABLETool to list user workspace Datatank tables with pagination support. Use when you need to retrieve datatank tables for a specific user, workspace, and datatank.

Input Parameters

integer
Maximum number of items to return (1-100). If not specified will default to 25.
string
Pagination token for fetching the next page of results.
string
required
The handle of the user.
string
required
The handle of the datatank.
string
required
The handle of the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_DB_LOGSTool to list database query logs for a specific user workspace. Use when you need to retrieve workspace database query history with optional pagination.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. Defaults to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user who owns the workspace
string
required
The handle of the workspace whose database logs to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_FLOWPIPE_INPUTTool to list Flowpipe inputs for a user workspace. Use when you need to retrieve all Flowpipe inputs for a specific workspace with optional pagination.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user to which the workspace belongs.
string
required
The handle of the workspace to which the Flowpipe inputs belong.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_FLOWPIPE_MOD_VARIABLETool to list all variables for a flowpipe mod in a user workspace. Use when you need to retrieve mod variables within a specific workspace owned by a user.

Input Parameters

integer
Maximum items per page (1-100 range). If not specified will default to 25.
string
required
The mod alias or mod ID for which we want the variables to be listed
string
Pagination cursor for fetching subsequent pages. When list results are truncated, next_token will be returned to fetch the next page of data.
string
required
The handle of the user that owns the workspace
string
required
The handle of the workspace where the mod was installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_FLOWPIPE_PIPELINETool to list Flowpipe pipelines for a user workspace. Use when you need to retrieve pipelines within a specific workspace belonging to a user.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user which contains the workspace.
string
required
The handle of the workspace for which we want to list the pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_FLOWPIPE_PIPELINE_TRIGGERTool to list Flowpipe triggers associated with a specific pipeline in a user workspace. Use when you need to retrieve all triggers configured for a particular pipeline.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The id of the pipeline whose triggers need to be fetched.
string
required
The handle of the user which contains the workspace.
string
required
The handle of the workspace where the pipeline exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_FLOWPIPE_TRIGGERTool to list Flowpipe triggers for a user workspace. Use when you need to retrieve all triggers configured in a specific user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user which contains the workspace.
string
required
The handle of the workspace for which we want to list the triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_INTEGRATIONTool to list integrations available for a user workspace. Use when you need to retrieve all integrations configured for a specific user workspace. If run on a custom tenant, this will return integrations configured both on tenant and user level.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user to which the workspace belongs to.
string
required
The handle of the workspace for whom you want to list available integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_MODTool to list user workspace installed mods with pagination support. Use when you need to retrieve installed mods for a specific user and workspace.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user who owns the workspace.
string
required
The handle of the workspace where mods were installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_MOD_VARIABLETool to list all variables applicable for a mod in a workspace specific to a user. Use when you need to retrieve mod variables within a specific user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25
string
required
The alias of the mod
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data
string
required
The handle of the user for which we want to list the workspace mod variables
string
required
The handle of the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_NOTIFIERTool to list all notifiers for a user workspace. Use when you need to view notification endpoints configured for a specific user’s workspace with optional pagination and filtering.

Input Parameters

integer
The maximum number of items to return
string
The filter to apply to the list
string
The token to retrieve the next page of results
string
required
The handle of the user for which the notifiers are to be listed
string
required
The handle of the workspace for which the notifiers are to be listed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_PIPELINETool to list pipelines for a workspace of a user. Use when you need to retrieve scheduled tasks for dashboard snapshots or queries within a specific user workspace.

Input Parameters

integer
Maximum number of items to fetch per page (1-100). Defaults to 25 if not specified.
string
SQL where filter to apply to this request. The filter will be parsed, sanitised and checked against supported columns.
string
Pagination cursor returned from previous request to fetch the next page of results.
string
required
The handle of the user who owns the workspace.
string
required
The handle of the workspace for which to list the pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_PROCESSTool to list processes associated with a user workspace. Use when you need to retrieve all processes for a specific user workspace with optional filtering and pagination.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user for which you want to start listing processes.
string
required
The handle of the workspace where you want to list the processes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACESList workspaces associated with a specific user handle, with pagination support.

Input Parameters

integer
Maximum number of workspaces to fetch per page (1-100). Defaults to 25 if not specified.
string
Pagination cursor returned from previous request to fetch the next page of results.
string
required
The handle of the user for which to list workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_SCHEMATool to list schemas for a user workspace. Use when you need to retrieve schemas including aggregators, datatanks, and identity-level connections for a specific user’s workspace.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user that the workspace belongs to
string
required
The handle of the workspace to get the schemas for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_SCHEMA_TABLETool to list tables for a user workspace schema with pagination support. Use when you need to retrieve tables for a specific user, workspace, and schema.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The name of the schema for which to list tables.
string
required
The handle of the user.
string
required
The handle of the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_SNAPSHOTTool to list workspace snapshots for a user. Use when you need to retrieve snapshots from a specific user workspace with optional pagination.

Input Parameters

integer
The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not provided, defaults to 25.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data.
string
required
The handle of the user that the workspace snapshots belong to
string
required
The handle of the user workspace whose snapshots to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_LIST_USER_WORKSPACE_USAGETool to list the usage associated with a user workspace. Use when you need to retrieve usage metrics for a specific user’s workspace with optional filtering and pagination.

Input Parameters

integer
The max number of items to fetch per page of data (1-100). If not specified will default to 25.
string
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
string
When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
string
required
The handle of the user for which you want to list workspace usage.
string
required
The handle of the workspace where you want to list the usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_POST_USER_WORKSPACE_NOTIFIER_COMMANDSet a notifier as the default in a user’s workspace by submitting a notifier command.

Input Parameters

string ("set_default")
required
Command to execute on the workspace notifier. Valid command: set_default
string
required
The handle of the user for which the notifier command is being executed
string
required
The name of the notifier where the command is directed
string
required
The handle of the workspace containing the notifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_POST_USER_WORKSPACE_QUERYTool to perform a SQL query in a user workspace. Use when you need to execute queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

Input Parameters

string
required
SQL query to execute against the workspace. Results are limited to 5000 rows or 30 seconds of query execution
string
required
The handle of the user that owns the workspace
string
required
The handle of the workspace where the query will be executed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_RUN_ORG_WORKSPACE_COMMANDRun a reboot command on an organization workspace.

Input Parameters

string ("reboot")
required
The command to run on the workspace. Valid commands are: reboot.
string
required
The handle of the org where we want to run the workspace command.
string
required
The handle of the workspace where command will be executed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_RUN_USER_WORKSPACE_COMMANDRun a reboot command on a user’s workspace.

Input Parameters

string ("reboot")
required
The command to run on the workspace. Valid commands are: reboot.
string
required
The handle of the user where we want to run the workspace command.
string
required
The handle of the workspace where command will be executed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_RUN_USER_WORKSPACE_FLOWPIPE_PIPELINE_COMMANDTool to run a command on a Flowpipe pipeline in a user workspace. Use when you need to execute a pipeline command such as ‘run’ to start pipeline execution.

Input Parameters

object
Arguments to pass to the pipeline command.
string ("run")
required
The command to run on the pipeline. Currently only ‘run’ is supported.
string
required
The handle of the user which contains the workspace.
string
required
Identifier of the Flowpipe pipeline on which the command will be run.
string
required
The handle of the workspace where the Flowpipe pipeline exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_RUN_USER_WORKSPACE_FLOWPIPE_TRIGGER_COMMANDTool to run a command on a trigger in a workspace belonging to a user. Use when you need to execute or reset a Flowpipe trigger.

Input Parameters

object
Optional arguments to pass to the trigger when executing the command.
string ("run" | "reset")
required
Command to execute on the trigger. Valid commands are: run (execute the trigger), reset (reset the trigger state).
string
required
The handle of the user which contains the workspace.
string
required
The name of the flowpipe trigger to execute the command on.
string
required
The handle of the workspace where the trigger exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_RUN_USER_WORKSPACE_QUERYTool to perform a SQL query in a user workspace using POST method. Use when you need to execute queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

Input Parameters

string
required
SQL SELECT statement to execute against the workspace. Results are limited to 5000 rows or 30 seconds of query execution
string ("json" | "csv" | "md")
required
Output format extension that determines response content type (json, csv, or md)
string
required
The handle of the user that owns the workspace
string
required
The handle of the workspace where the query will be executed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_SEND_USER_WORKSPACE_CHAT_MESSAGESend a chat message to the AI agent in a user workspace, using the selected provider and model. Start a new conversation or continue an existing one; the result provides conversation metadata, not the agent’s reply.

Input Parameters

string
required
The AI model to use (e.g., ‘gpt-4’, ‘claude-sonnet-4-5’).
string
required
The chat message to send to the AI agent.
string
required
The AI provider to use (e.g., ‘openai’, ‘anthropic’).
string
required
The handle of the user that owns the workspace.
string
The ID of an existing conversation to continue. If not provided, a new conversation will be created. Must match pattern ^conv[0-9a-v]{20}$
string
required
The handle of the user workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_TEST_USER_AI_KEYTool to test whether an AI provider API key is valid at the user level. Use when you need to verify if a saved or provided API key works correctly with the specified provider.

Input Parameters

string
The API key to validate against the specified provider. If not provided, tests the existing saved key for the provider
string ("openai" | "anthropic")
required
AI provider to test the key against (openai or anthropic)
string
required
Handle of the user for which to test the AI key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_TEST_USER_CONNECTIONTool to test a user connection for basic connectivity. Use when you need to verify if a connection’s configuration is valid and the credentials work correctly with the specified plugin.

Input Parameters

object
Optional configuration object for the connection test. The structure depends on the plugin type
string
required
The plugin type for the connection (e.g., ‘aws’, ‘gcp’, ‘azure’)
string
required
The handle of the user where the connection exists
string
required
The handle of the connection to be tested

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_TEST_USER_INTEGRATIONTool to test the config for a user integration to check for basic connectivity before you create it. Use when you need to validate integration credentials and configuration by providing the user handle, integration handle (or _ for new integrations), integration type, and config.

Input Parameters

string
required
The type of the integration being tested (e.g., slack, github, email).
object
required
Configuration properties for the integration. The structure varies based on the integration type.
string
required
The handle of the user to which the integration belongs to.
string
required
The handle of the integration to be tested. For integrations that are not yet created, use underscore _ as the handle, else pass the handle of the existing integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_TEST_USER_WORKSPACE_CONNECTIONTool to test the config for a connection configured on a user workspace to check for basic connectivity. Use when you need to verify that a connection is properly configured before creating or using it.

Input Parameters

object
Optional configuration data for the connection test
string
required
The plugin name for the connection to be tested
string
required
The handle of the user where the connection exists / intends to be created
string
required
The handle of the workspace where the connection exists
string
required
The handle of the connection to be tested. For connections that are not yet created, use underscore _ as the handle, else pass the handle of the existing connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UNINSTALL_FLOWPIPE_MODTool to uninstall a flowpipe mod from a user’s workspace. Use when you need to remove a flowpipe mod from a specific workspace after confirming the user handle, workspace handle, and mod alias.

Input Parameters

string
required
Unique alias or identifier of the flowpipe mod to uninstall
string
required
Unique handle or identifier for the user who owns the workspace
string
required
Unique handle or identifier for the workspace from which to uninstall the mod

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UNINSTALL_ORG_WORKSPACE_FLOWPIPE_MODTool to uninstall a flowpipe mod from an organization workspace. Use when you need to remove a flowpipe mod from a specific workspace after confirming org handle, workspace handle, and mod alias.

Input Parameters

string
required
The mod alias or mod ID to delete
string
required
The handle of an organization that owns the workspace
string
required
The handle of the workspace where the mod was installed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_CONVERSATION_USERUpdate the title of an AI conversation in a user workspace.

Input Parameters

string
required
The new title for the conversation
string
required
The handle of the user that owns the workspace
string
required
The unique identifier of the conversation to update
string
required
The handle of the user workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_ORG_BILLING_SUBSCRIPTIONTool to update an organization billing subscription. Use to stop cancellation at the next billing period by passing ‘stopcancel’ action or to upgrade the subscription. Useful when managing org subscription lifecycle.

Input Parameters

string ("stopcancel" | "upgrade")
required
Action to perform on the subscription. Use ‘stopcancel’ to stop cancellation at the next billing period, or ‘upgrade’ to upgrade the subscription
string
required
The handle of the organization
string
required
The org subscription id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_ORG_CONNECTIONTool to update the details of a connection belonging to an organization. Use when you need to modify connection configuration, change config/credential sources, rename the connection handle, or reassign the connection to a different parent entity.

Input Parameters

object
The plugin or connection configuration
string
The handle name for the connection. Must match pattern: lowercase letter, followed by alphanumeric or underscore (not ending with underscore), max 39 chars
string
The ID of the entity where the connection is stored. Can be either tenant, identity, workspace or connection-folder
string
required
The handle of the organization where the connection exists
string ("self" | "inherited")
Source of the configuration for the connection.
string
required
The handle of the connection which needs to be updated
string ("self" | "inherited")
Source of the credential for the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_ORG_CONNECTION_FOLDERTool to update the details of an org connection folder. Use when you need to modify the title or parent location of a connection folder.

Input Parameters

string
The new title for the connection folder. Must match pattern: ^a-z){0,38}$ (lowercase letters, numbers, underscores, 1-39 chars).
string
required
The unique identifier of the connection folder to update.
string
The new parent ID for the connection folder. Use to move the folder to a different parent location.
string
required
The handle of the organization that owns the connection folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_ORG_MEMBERTool to update the role of an organization member. Use when you need to change a member’s role (e.g., promote to owner or demote to member) within an organization.

Input Parameters

string
required
The role to assign to the org member. Common values include ‘owner’, ‘member’, ‘viewer’
string
required
The handle of the organization
string
required
The handle of the user/member to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_ORG_SERVICE_ACCOUNTTool to update an existing service account at the organization level. Use when you need to modify the title, description, or token_min_issued_at for a service account.

Input Parameters

string
The title of the service account user
string
required
The handle of the organization containing the service account
string
The description of the service account user
string
The time which user and temporary auth tokens must be issued after
string
required
The unique identifier of the service account to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_ORG_SERVICE_ACCOUNT_TOKENUpdate an organization service account token’s status, with optional changes to its title or description. Status is required for every update.

Input Parameters

string
The title or name of the token
string
required
The status of the token (e.g., ‘active’, ‘inactive’)
string
required
The identifier of the token to update
string
required
The handle of the organization
string
A description of the token
string
required
The ID of the service account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USERTool to update user information including handle name, display name, or URL. Use when you need to modify user attributes.

Input Parameters

string
The URL to set for the user.
string
The new handle name for the user. Must match pattern: ^[a-z0-9]{1,2}(?:[a-z0-9]{1,2}|-[a-z0-9]){0,18}[a-z0-9]?$
string
required
Specify the handle of the user which needs to be updated.
string
The display name to set for the user.
string
The time which user and temporary auth tokens must be issued after.
string ("warn" | "cap_and_warn")
Enum for usage action types.
string ("warn" | "cap_and_warn")
Enum for usage action types.
integer
Threshold for compute usage.
integer
Threshold for storage usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USER_AI_KEYTool to update an existing AI provider API key at the user level. Use when you need to update an API key for a specific AI provider (OpenAI or Anthropic) for a user.

Input Parameters

string
required
The new API key for the AI provider
string ("openai" | "anthropic")
required
AI provider for which to update the key (openai or anthropic)
string
required
Handle of the user that owns the AI key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USER_CONNECTIONTool to update the details of a connection belonging to a user. Use when you need to modify configuration, handle, parent_id, config_source, or credential_source of a user’s connection. Requires user_handle and connection_handle to identify the target connection.

Input Parameters

string ("available")
Mode of the request.
object
The plugin or connection configuration. This is a flexible object that can contain various configuration parameters depending on the connection type
string
The handle name to update for the connection. Must start with a lowercase letter, followed by up to 38 lowercase letters, digits, or underscores. Maximum length is 39 characters
string
The id of the entity where the connection is stored. Can be either tenant, identity, workspace or connection-folder
string
required
The handle of the user where the connection exists
string ("self" | "inherited")
Source of the configuration that the connection will use.
string
required
The handle of the connection which needs to be updated
string ("self" | "inherited")
Source of the credential that the connection will use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USER_INTEGRATIONTool to update details of an integration configured for a user. Use when you need to modify an existing user integration’s state, handle, or configuration.

Input Parameters

string ("enabled" | "disabled")
Integration state enum.
object
The configuration for the integration.
string
The handle for the integration.
string
required
The handle of the user on which the integration is configured.
string
required
The handle of the integration whose details need to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USER_PREFERENCESTool to update user preferences for email communications. Use when you need to change a user’s communication preferences such as opting in or out of product updates, community updates, or tips and tricks emails.

Input Parameters

string
required
Specify the handle of the user whose preferences need to be updated.
string ("enabled" | "disabled")
Communication preference setting for email notifications.
string ("enabled" | "disabled")
Communication preference setting for email notifications.
string ("enabled" | "disabled")
Communication preference setting for email notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USER_TOKENUpdate a user’s token status to active or inactive without deleting it. The token’s title and description can also be updated in the same request.

Input Parameters

string
Optional title to update for the token
string ("active" | "inactive")
required
New status for the token - ‘active’ to activate or ‘inactive’ to deactivate the token
string
required
The identifier of the token to update
string
Optional description to update for the token
string
required
The handle of the user where the token exists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_UPDATE_USER_WORKSPACETool to update the workspace for a user. Use when you need to modify workspace settings such as desired state, instance type, database volume size, or search path prefix.

Input Parameters

string
The new handle for the workspace. Must match pattern: ^[a-z0-9]{1,23}$
string
required
The handle of the user where the workspace exist.
string ("enabled" | "disabled")
Workspace desired state enum.
string ("db1.shared" | "db1.small" | "db1.medium")
Workspace instance type enum.
string
required
The handle of the workspace which needs to be updated.
array
Optionally update the search path prefix for the Steampipe DB.
integer
The size of the database volume in bytes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_USER_NOTIFIERS_LISTTool to list all notifiers for a user. Use when you need to view a user’s configured notification endpoints.

Input Parameters

string
required
Handle of the user whose notifiers to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_USER_TOKENS_DELETETool to delete a specific user token. Use when you need to revoke a user’s token after confirming handle and token ID.

Input Parameters

string
required
Unique identifier of the token to be deleted
string
required
Unique handle or identifier for the user whose token will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TURBOT_PIPES_USER_TOKENS_GETRetrieve metadata for a specific user token by user handle and token ID, including its creation time and status.

Input Parameters

string
required
Unique identifier of the token to retrieve
string
required
Handle of the user in the system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not