> For the complete documentation index, see [llms.txt](https://docs.couchdrop.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.couchdrop.io/automations/triggers/runnable-actions.md).

# Runnable Actions

Learn about Runnable Actions that can be shared with other users.

Runnable Actions are workflow methods designed for teams to run secure file workflows without needing to understand the technical details behind them. 

The triggering user simply needs to select the action and add the file to trigger the pre-configured flow, and does not need to know the flow steps or worry about formatting, encryption, or protocol requirements.  

## How to use Runnable Actions

With Runnable Actions, admins can build file processing workflows and allow users to trigger them with a simple upload. 

{% hint style="warning" %}

#### Before you start

To use Runnable Actions, you will need:

* An account with Automations enabled
* One or more other users to share the Automation with. These users must have the **Allow Web Portal** permission enabled. 
  {% endhint %}

{% stepper %}
{% step %}

### Configure the automation to share

Build an automation to share with other users. 

1. For the trigger, select **Runnable Action.** 
2. Add [custom variables](#custom-display-variables) if needed. 
3. Create the automation flow. This automation should act on a file, as the user will add a file from their web portal to activate it. There is no limit to the number of steps/actions. 
   {% endstep %}

{% step %}

### Share the workflow as a Runnable Action

After configuring the workflow as an Action, go to the workflow **Settings** tab and go to **User and Group Access**. Select Users/Groups that can view and run the action. The action will appear in their Actions tab when they log in to the web portal. 
{% endstep %}

{% step %}

### Test the Action

Have the user test the action with a file and ensure that it runs successfully. 
{% endstep %}
{% endstepper %}

### Custom display variables

When setting up a Runnable Action, you can display context to the user to help them understand how to use the action properly. 

Click to Add a Variable for the display variable menu to appear. 

<table><thead><tr><th width="274.59375">Field</th><th>Description</th></tr></thead><tbody><tr><td>Display Name</td><td>The name shown to the user running the action</td></tr><tr><td>Display Description</td><td>A text description that coincides with the variable. </td></tr><tr><td>Custom Variable Name</td><td>A name for your custom variable</td></tr><tr><td>Custom Variable Type</td><td>The variable type/format. Choose from Text, Text List, and JSON List. </td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.couchdrop.io/automations/triggers/runnable-actions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.