Building Actions

Creating an Action

Click + Create Action to begin building a new Action.

Building a new Action is very similar to building in a regular Xano function stack. You can add inputs, functions, and define a response.

Please note that because Actions are designed to not have dependencies outside of the Action itself, certain functions such as database operations are not available.

Action Settings

Click the three dots in the upper-right corner to access Action Settings. From this panel, you can update the following:

Name - Give your action a unique name

Instructions - You can write documentation to accompany your action here. This field supports markdown for formatting. View the expandable section below for a quick reference.

Quick Markdown Reference
# Header 1
## Header 2
### Header 3

*Italic* or _Italic_
**Bold** or __Bold__
***Bold and Italic*** or ___Bold and Italic___

- Item 1
- Item 2
  - Subitem 2.1

1. First item
2. Second item
   1. Subitem 2.1

[Link text](https://www.example.com)

[Alt text](image-url.jpg)

`inline code`

```code block```

You can also preview your instructions using the Preview tab.

Category - You must provide a category for your Action before publishing

Video URL - You can insert a YouTube or Loom video link here to accompany your action

Publishing

When you publish your Action, you'll be able to review and make any changes to the documentation and certain Action settings once more before going live.

Make sure to choose the appropriate access level for your Action.

Public - This Action will be available for anyone to browse for, install and use.

Private - This Action will not be available for distribution. Use this for specific Actions that you only want to use internally.

Unlisted - This Action will be available to anyone that has the URL, but will not be found when browsing available Actions.

Scoped Functions

Scoped Functions are an implementation similar to Custom Functions, but usable in Actions. Each Action can have scoped functions defined, allowing you to reuse pieces of logic inside of the Action.

Click the button in the top-right section of the page when building an Action to access scoped functions.

You can now build, run, and debug your scoped function just like any other function stack, and use it inside of your Action. The experience is almost identical to our Custom Functions feature.

Settings Registry

Because Actions have no dependencies, each Action contains a Settings Registry, which is used in a similar manner to environment variables. You will use the Settings Registry for situations where an Action requires an API key or other sensitive data that you need to ensure users of the Action supply without supplying it yourself.

To add a new value to the Settings Registry, just add a new input to your Action. In the settings for that input, you'll see a new option in the Configuration section called Settings Registry.

Checking this box will mark this input as part of the Settings Registry, enabling you to provide your own data for testing and make sure it is apparent when these values need to be provided for others utilizing the Action you are building.

Last updated