<footer id="WIX_FOOTER" style="visibility:hidden;" class><nav class="zEGd0F" aria-label="More Wix pages" data-hook="footer__wrapper"><div class="qiiRxY"><div class="qSmvZl"><a class="LtfG6S" aria-label="Wix logo, homepage" title="Wix.com" href="https://www.wix.com"><svg xmlns="http://www.w3.org/2000/svg" width="71" height="28" fill="none" viewBox="0 0 166 64"><g fill="#000" clip-path="url(#a)"><path d="M165.301 0h-9.131a7.64 7.64 0 0 0-6.323 3.352l-12.212 18.014a.82.82 0 0 1-1.356 0L124.068 3.352A7.64 7.64 0 0 0 117.745 0h-9.131l21.753 32.09L108.734 64h9.131a7.64 7.64 0 0 0 6.323-3.352l12.091-17.836a.82.82 0 0 1 1.356 0l12.091 17.836A7.64 7.64 0 0 0 156.05 64h9.131l-21.634-31.91zM89.828 6.546V64h4.364a6.546 6.546 0 0 0 6.547-6.547V0h-4.364a6.546 6.546 0 0 0-6.547 6.546M81.83 0h-3.885a9.154 9.154 0 0 0-8.928 7.126L60.33 45.318 52.725 9.666C51.318 3.077 44.557-1.367 37.639.544c-4.407 1.217-7.674 4.94-8.627 9.41L21.485 45.27 12.813 7.128A9.16 9.16 0 0 0 3.883 0H0l14.555 63.997h5.515c5.004 0 9.328-3.499 10.372-8.393l9.305-43.664c.114-.542.6-.934 1.153-.934.552 0 1.038.392 1.153.934l9.312 43.667a10.6 10.6 0 0 0 10.373 8.39h5.533z"></path></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h165.305v64H0z"></path></clipPath></defs></svg></a><p class="bUSBWm">The Wix website builder offers a complete solution from enterprise-grade infrastructure and business features to advanced SEO and marketing tools–enabling anyone to create and grow online.</p><ul class="uLHFcA"><li><a href="https://www.wix.com/about/us" target="_self" class="PlWjyD">About</a></li><li><a href="https://www.wix.com/about/contact-us" target="_self" class="PlWjyD">Contact Us</a></li></ul><ul class="SUCknL FgSyBI" data-hook="social-bar__wrapper"><li><a class="ACLKzf" href="https://www.facebook.com/wix" target="_blank" aria-label="facebook" title="Facebook" data-hook="social-bar__socialLink socialLink--id_facebook"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M10 0C-2.399.363-3.663 17.76 8.43 20v-7.03H5.876V10.06H8.43V7.845c.072-4.058 3.333-4.207 6.047-3.718v2.476H13.21c-1.249 0-1.639.775-1.639 1.57v1.888h2.788l-.445 2.909H11.57V20C23.666 17.759 22.396.362 10 0"></path></svg></a></li><li><a class="ACLKzf" href="https://www.youtube.com/user/Wix" target="_blank" aria-label="youtube" title="Youtube" data-hook="social-bar__socialLink socialLink--id_youtube"><svg xmlns="http://www.w3.org/2000/svg" width="28" height="20" fill="none" viewBox="0 0 28 20"><path fill="#000" d="M11.83.005c-2.96.056-4.594.12-6.14.237C3.805.385 3.093.511 2.475.81c-.357.173-.62.357-.92.648C.825 2.173.53 2.913.321 4.569l-.085.67a45 45 0 0 0-.162 2.222c-.099 2.083-.099 2.994 0 5.083.03.662.121 1.906.162 2.221l.085.67c.21 1.657.503 2.397 1.234 3.112.714.696 1.393.95 3.008 1.118C6.72 19.89 9.763 20 14 20c3.646 0 6.203-.073 8.31-.235 1.899-.148 2.597-.27 3.215-.57.357-.173.62-.357.92-.648.73-.715 1.025-1.455 1.234-3.111l.085-.67c.04-.316.132-1.56.162-2.222.099-2.089.099-3 0-5.083a45 45 0 0 0-.162-2.221l-.085-.67c-.21-1.657-.503-2.397-1.234-3.112C25.956.98 25.43.695 24.736.536c-.983-.23-3.269-.397-6.684-.492A295 295 0 0 0 11.83.005m.192 6.266c1.055.611 2.063 1.195 5.324 3.08.594.341 1.083.635 1.083.651 0 .014-.789.484-1.753 1.04a2861 2861 0 0 0-5.511 3.187c-.014.006-.022-1.897-.022-4.226 0-2.33.008-4.232.022-4.227.01.003.395.226.857.495"></path></svg></a></li><li><a class="ACLKzf" href="https://www.instagram.com/wix" target="_blank" aria-label="instagram" title="Instagram" data-hook="social-bar__socialLink socialLink--id_instagram"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M5.858.07c-1.064.05-1.79.22-2.425.47-.658.256-1.215.6-1.77 1.156a4.9 4.9 0 0 0-1.15 1.772C.267 4.105.1 4.832.053 5.897s-.057 1.407-.052 4.122c.005 2.716.017 3.056.069 4.123.05 1.064.22 1.79.47 2.426.256.657.6 1.214 1.156 1.769a4.9 4.9 0 0 0 1.774 1.15c.636.245 1.363.413 2.428.46 1.064.046 1.407.057 4.122.052s3.056-.017 4.123-.068c1.067-.05 1.79-.221 2.425-.47a4.9 4.9 0 0 0 1.769-1.156 4.9 4.9 0 0 0 1.15-1.774c.246-.636.413-1.363.46-2.427.046-1.067.057-1.408.052-4.123s-.018-3.056-.068-4.122c-.05-1.067-.22-1.79-.47-2.427a4.9 4.9 0 0 0-1.156-1.769 4.9 4.9 0 0 0-1.773-1.15C15.895.269 15.168.1 14.104.054 13.039.009 12.697-.003 9.98.002S6.925.018 5.858.07m.117 18.078c-.975-.043-1.504-.205-1.857-.34-.467-.18-.8-.398-1.152-.746a3.1 3.1 0 0 1-.75-1.149c-.137-.352-.302-.881-.347-1.856-.05-1.054-.06-1.37-.066-4.04s.004-2.986.05-4.04c.042-.974.205-1.504.34-1.857.18-.468.397-.8.746-1.151a3.1 3.1 0 0 1 1.15-.75c.351-.138.88-.302 1.855-.348 1.054-.05 1.37-.06 4.04-.066s2.986.004 4.041.05c.974.043 1.505.204 1.857.34.467.18.8.397 1.151.746.352.35.568.682.75 1.15.138.35.302.88.348 1.855.05 1.054.062 1.37.066 4.04s-.004 2.986-.05 4.04c-.043.975-.205 1.504-.34 1.857a3.1 3.1 0 0 1-.747 1.152c-.349.35-.681.567-1.148.75-.352.137-.882.301-1.855.347-1.055.05-1.371.06-4.042.066s-2.985-.005-4.04-.05m8.153-13.493a1.2 1.2 0 1 0 2.4-.003 1.2 1.2 0 0 0-2.4.003M4.865 10.01a5.134 5.134 0 1 0 10.27-.02 5.134 5.134 0 0 0-10.27.02m1.802-.004a3.334 3.334 0 1 1 6.667-.013 3.334 3.334 0 0 1-6.667.013"></path></svg></a></li><li><a class="ACLKzf" href="https://www.tiktok.com/@wix" target="_blank" aria-label="tiktok" title="TikTok" data-hook="social-bar__socialLink socialLink--id_tiktok"><svg xmlns="http://www.w3.org/2000/svg" width="17" height="20" fill="none" viewBox="0 0 17 20"><path fill="#000" d="M14.46 4.009A4.8 4.8 0 0 1 12.417.873 5 5 0 0 1 12.337 0H8.986L8.98 13.78c-.057 1.544-1.294 2.782-2.811 2.782-.472 0-.916-.121-1.307-.332a2.9 2.9 0 0 1-1.51-2.558c0-1.594 1.263-2.89 2.817-2.89.29 0 .568.048.831.133v-3.51a6 6 0 0 0-.831-.062C2.767 7.343 0 10.183 0 13.672a6.37 6.37 0 0 0 2.633 5.181A6.03 6.03 0 0 0 6.17 20c3.4 0 6.168-2.839 6.168-6.329V6.683A7.83 7.83 0 0 0 17 8.222V4.783a4.55 4.55 0 0 1-2.539-.775z"></path></svg></a></li><li><a class="ACLKzf" href="https://www.pinterest.com/wixcom" target="_blank" aria-label="pinterest" title="Pinterest" data-hook="social-bar__socialLink socialLink--id_pinterest"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M10 0C4.479 0 0 4.477 0 10a10 10 0 0 0 5.986 9.159c-.03-.699-.006-1.536.173-2.296.193-.812 1.288-5.45 1.288-5.45s-.32-.638-.32-1.581c0-1.483.86-2.59 1.928-2.59.91 0 1.35.685 1.35 1.502 0 .914-.583 2.282-.883 3.549-.25 1.06.532 1.926 1.577 1.926 1.895 0 3.172-2.434 3.172-5.317 0-2.19-1.476-3.831-4.161-3.831-3.034 0-4.923 2.261-4.923 4.788 0 .872.256 1.486.66 1.96.183.22.21.308.142.559-.048.184-.157.627-.204.802-.066.254-.271.344-.5.251-1.398-.571-2.047-2.1-2.047-3.82 0-2.842 2.395-6.247 7.145-6.247 3.819 0 6.333 2.762 6.333 5.728 0 3.923-2.182 6.854-5.398 6.854-1.079 0-2.094-.585-2.442-1.247 0 0-.581 2.304-.703 2.749-.213.77-.628 1.542-1.007 2.142.9.265 1.85.41 2.835.41C15.524 20 20 15.523 20 9.999 20 4.477 15.524 0 10 0"></path></svg></a></li><li><a class="ACLKzf" href="https://twitter.com/wix" target="_blank" aria-label="twitter" title="Twitter" data-hook="social-bar__socialLink socialLink--id_twitter"><svg xmlns="http://www.w3.org/2000/svg" width="19" height="20" fill="none" viewBox="0 0 19 20"><path fill="#000" d="m.044.063 7.352 11.022.023.034-3.667 4.39-3.71 4.44L0 20h1.677l3.241-3.881c1.783-2.134 3.242-3.88 3.245-3.88.002 0 1.169 1.745 2.592 3.88L13.344 20H19l-.023-.035-3.84-5.758c-2.1-3.148-3.82-5.73-3.82-5.737a883 883 0 0 1 3.527-4.234C16.783 1.914 18.372.01 18.372.006A28 28 0 0 0 17.54 0h-.835L13.64 3.67a1080 1080 0 0 1-3.074 3.673c-.004.001-1.11-1.65-2.457-3.67L5.658 0H0zM5.339 2.01l11.36 16.74c.005.007-.253.01-1.28.01h-1.286l-2.7-3.977L5.512 6.06C3.739 3.447 2.289 1.308 2.289 1.304s.54-.008 1.283-.008h1.281z"></path></svg></a></li><li><a class="ACLKzf" href="https://www.linkedin.com/company/wix-com?trk=biz-companies-cym" target="_blank" aria-label="linkedin" title="Linkedin" data-hook="social-bar__socialLink socialLink--id_linkedin"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M18.522.003C15.446-.006 4.1.009 1.478.003.662.003 0 .645 0 1.435v17.133C0 19.358.662 20 1.478 20h17.044c.816 0 1.478-.641 1.478-1.432V1.435c0-.79-.662-1.432-1.478-1.432M6.078 16.738H3.085V7.735h2.993v9.003M4.582 6.506c-1.008.01-1.675-.684-1.673-1.555-.003-2.06 3.358-2.084 3.366 0 0 .864-.65 1.555-1.693 1.555M16.87 16.738h-2.993v-4.816c0-1.21-.433-2.036-1.516-2.036-1.111.04-1.663.901-1.634 1.825v5.027H7.735s.039-8.158 0-9.002h2.992l-.02 1.305c.394-.615 1.103-1.517 2.718-1.517 1.968 0 3.445 1.287 3.445 4.052z"></path></svg></a></li></ul></div><div class="lcWAzl"><div class="C2Sjqd" data-hook="column__column column--name_product"><p class="FBGLaT">Product</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/website/templates" target="_self">Website Templates</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com" target="_self">Website Builder</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/website/design" target="_self">Website Design</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/features/main" target="_self">Wix Features</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/app-market" target="_blank">App Market</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/free/web-hosting" target="_self">Web Hosting</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/domains" target="_self">Domain Names</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/accessibility" target="_self">Website Accessibility</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/app-builder" target="_self">Mobile App Builder</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_solutions"><p class="FBGLaT">Solutions</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/ecommerce/online-store" target="_blank">Online Store</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/scheduling-software" target="_blank">Online Booking</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/restaurant/website" target="_self">Restaurant Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/start/blog" target="_self">Blog Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/portfolio-website" target="_self">Portfolio Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/ecommerce/website" target="_blank">eCommerce Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/studio" target="_self">Wix Studio</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/studio/enterprise" target="_self">Enterprise Solutions</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/students" target="_self">Student Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/tools" target="_self">Professional Tools</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/logo/maker" target="_blank">Logo Maker</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_learn"><p class="FBGLaT">Learn</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/blog" target="_blank">Wix Blog</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/manage/privacy-security-hub" target="_self">Privacy and Security Hub</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/seo/learn" target="_blank">SEO Learning Hub</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/encyclopedia" target="_blank">Wix Encyclopedia</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_support"><p class="FBGLaT">Support</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://support.wix.com/en" target="_self">Help Center</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/marketplace" target="_blank">Hire a Professional</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/abuse" target="_self">Report Abuse</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://status.wix.com" target="_self">System Status</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_company"><p class="FBGLaT">Company</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/press-room/home" target="_self">Press &amp; Media</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://investors.wix.com" target="_self">Investor Relations</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/wix-capital" target="_self">Wix Capital</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/about/terms-accessibility" target="_self">Accessibility Statement</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/about/patent-notice" target="_self">Patent Notice</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/about/sitemap" target="_self">Sitemap</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://careers.wix.com" target="_self">Careers</a></li></ul></div></div></div><div class="PXtX5X"><div class="q2YDTr ehx5BU"><div class="JwIlOl"><div class="waU9GL"><ul class="fLy152"><li><a href="https://www.wix.com/about/terms-of-use" target="_self" class="FzJOdO">Terms of Use</a></li><li><a href="https://www.wix.com/about/privacy" target="_self" class="FzJOdO">Privacy Policy</a></li></ul><span class="GiYy1B">© 2006-2025 Wix.com, Inc</span></div></div></div></div></nav></footer>

Get to know our frameworks

Select an app template built on your preferred framework.

Build native Wix apps using a drag-and-drop editor, and add custom code for your business logic.

Streamline your app development process by coding on your local machine with your preferred IDE.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart app development and get a practical foundation that you can customize and build upon with templates built for your preferred Wix framework.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

# Introduction

The Automations V2 API allows you to manage automations on user sites. Automations are workflows that let site owners automate tasks they would otherwise have to perform manually. For example, a site owner with an online store can set up an automation to send an invoice to a customer after they make a purchase.

Learn more about [Automations](fallback::https://support.wix.com/en/article/wix-automations-about-the-new-automations-builder).

Using the Automations V2 API, you can:

- [Configure automation triggers and actions](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/configure-your-automation).
- [Create](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/create-automation), [query](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/query-automations), [update](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/update-automation), and [delete](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/delete-automation) site automations.






## Automation setup

When creating an automation, you must configure it with 1 trigger and at least 1 action. The trigger and action must already exist, as you can't create them using this API. In addition, the apps that created the trigger and actions configured in your automation must be installed on the site you're creating the automation for.

To define a trigger, specify the ID of the app that created the trigger, as well as the trigger key. You can further [configure the trigger](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/configure-your-automation) as necessary.

To add actions, provide each action's key and [configuration](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/configure-your-automation#backend-modules_automations_automations-v2_configuring-actions) details. Additionally, you must define your root actions. These are the first actions to run when when the automation trigger occurs.

> **Note**: You can currently only specify 1 root action.

In addition to defining the trigger and actions, you must define the automation's origin and activation status when added to the site. An automation can have 1 of 3 possible origins:

- **User**: A site owner built the automation in their site dashboard.
- **Application**: An app created the automation as part of its logic. This type of automation is specific to a site, and is not necessarily created for every user who has installed the app.
- **Pre-installed**: An app added the automation when it was installed on a site. Pre-installed automations aren't specific to one site, but are added to every site that installs the app.

When you create the automation, set its activation status as either active or inactive. This determines the automation's status when it's added to the site.

@package_metadata:@wix/automations

To use the AutomationsV2 API, install the `@wix/automations` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/automations` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/automations` or `yarn add @wix/automations`. |
| Headless sites and apps | Run `npm install @wix/automations` or `yarn add @wix/automations`. |

#### Import the package

To import the package in your code:

```js
import { automationsV2 } from '@wix/automations'
```

# Configure an Automation

In this article, we explain in more detail how to create and configure automations using the [Create Automation](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/create-automation) method. We'll go through the different configuration options for the full automation as well as its trigger and actions.

## Configuring the trigger

When configuring the trigger for your automation, specify the trigger key and the ID of the app that created the trigger. For example, if you use the "Subscribed to site" trigger, specify the following app ID and trigger key:

```json
{
  "trigger": {
    "appId": "c435f412-d571-4c48-aada-ddf65a4a56b4",
    "triggerKey": "wix_form_platform-subscription_confirmation_request",
    "filters": []
  }
}
```

You can also include any of the optional configuration described below.

### Filters

Use the `filters` array to apply [filter fields](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields) to your trigger. Filter fields allow you to filter which triggers activate an automation. For example, you may want your automation to trigger only if a certain form is submitted.

Filter expressions have an `AND` relation. This means that all filter expressions must evaluate to true for a given payload in order for the automation to run. An example of an added filter might look like this:

```json
{
  "trigger": {
    "appId": "c435f412-d571-4c48-aada-ddf65a4a56b4",
    "triggerKey": "wix_form_platform-subscription_confirmation_request",
    "filters": [{
      "id": "20672101-5cb6-495d-8e10-61c5d217e624",
      "fieldKey": "formID",
      "filterExpression": "function(formId) {
        const validIds = ["guid1", "guid2"];
        return validIds.includes(formId); 
      }"
    }]
  }
}
```

> **Important**: Before specifying any filters, you must first define them in the app dashboard as filter fields for the trigger. You can't create new filter fields with the API call.

### Scheduled events

Scheduled events let you schedule the trigger to activate before the event occurs. For example, this allows you to send a reminder email three days prior to a training session.

> **Important**: Before scheduling a trigger, you must first configure it as a scheduled event in the app dashboard.

Add the time offset value in `preScheduledEventOffsetExpression`. This is the amount of time by which to offset the time of the automation execution from the event. Note that this field expects a string, which can be hard-coded or a stored in variable specified in the payload.

For example, if you want the automation to run 5 days before the date of the event, you can configure your trigger in the following way:

```json
{
  "scheduledEventOffset": {
    "preScheduledEventOffsetExpression": 5,
    "scheduledEventOffsetTimeUnit": "DAYS"
  }
}
```

You can also use a variable, such as `timeOffset`, to specify the value of the offset expression:

```json
{
  "scheduledEventOffset": {
    "preScheduledEventOffsetExpression": "timeOffset",
    "scheduledEventOffsetTimeUnit": "DAYS"
  }
}
```

> **Note**: You can only use negative offsets from the event date (before the event). To schedule triggers to run after the event, use [delay actions](fallback::#action-type).

### Rate limits

Rate limits restrict the number of times a trigger activates. For example, you might want to send a site visitor a chat message only once, the first time they navigate to a page on your site, rather than every time they navigate to a new page.

To set a rate limit, you must define 4 parameters:

+ `maxActivationsExpression`: The maximum number of times the trigger should activate.
+ `durationExpression`: How long the rate limit should be active before expiring.
+ `durationTimeUnit`: The time unit in which to specify the rate limit duration.
+ `uniqueIdentifierExpression`: Identifier used by the rate limiter to count activations.

The `maxActivationsExpression` and `durationExpression` parameters are both strings that can accept either a hard-coded value or a variable specified in the payload. For example, you can set `maxActivationsExpression` to `1` or to the value of a variable such as `maxActivations`.

The `uniqueIdentifierExpression` can be any string created by any operator or payload field. The string can be a `contactID` but is not limited to that.

The following example limits the number of activations over a 10-hour period to the value stored in the `maxActivations` variable. The rate limiter uses the contact ID (for example, of the site visitor who triggers the automation) to count the activations:

```json
{
  "rateLimit": {
    "maxActivationsExpression": "maxActivations",
    "durationExpression": 10,
    "durationTimeUnit": "HOURS",
    "uniqueIdentifierExpression": "payload.contact.id"
  }
}
```



## Configuring actions

Actions are the steps that execute after a trigger activates.

When setting up an automation, you must define a map of all possible actions in the automation flow. Every action must be defined in key:value pairs:

+ For the map key, specify the action ID. This is an automation-specific UUID generated for every action in your automation.
+ For the map value, specify the action configuration, which includes the action's type, namespace, and related configuration details.

Here's an example of an action map (some configuration details are removed for conciseness):

```json
{
  "actions": {
    "92509b45-8b76-448c-bb51-7f0604bf1f07": {
      "id": "92509b45-8b76-448c-bb51-7f0604bf1f07",
    "type": "APP_DEFINED",
    "namespace": "customer-rewards",
    "appDefinedInfo": {
      "appId": "c7438f41-3e15-41cd-90c5-f17213281cf3",
      "actionKey": "send-a-coupon",
      "inputMapping": {
        /* ...Input mapping details... */
      },
      "skipConditionOrExpressionGroups": [],
      "postActionIds": []
      }
    },
    "c384e339-2683-4a4e-9c8f-86a3bfbca268": {
      "id": "c384e339-2683-4a4e-9c8f-86a3bfbca268",
      "type": "APP_DEFINED",
      "namespace": "calculations",
      "appDefinedInfo": {
        /* ...App info... */
      }
    },
    "3765519f-3f42-40c6-bee1-ac2ff6ed26e0": {
      "id": "3765519f-3f42-40c6-bee1-ac2ff6ed26e0",
      "type": "APP_DEFINED",
      "namespace": "notifications",
      "appDefinedInfo": {
        /* ...App info... */
      }
    },
  }
}
```

You must add at least 1 action ID to the `rootActionIds` array. The trigger activates these actions in parallel. Each root action can be followed by additional subsequent actions, if any are defined.

> **Note**: You can currently only specify 1 root action.

### Namespace

The action namespace is a human-readable name that distinguishes it from other actions of the same type. If an action outputs data, it is included under its namespace in the payload sent to subsequent actions in the automation flow.

You can provide the action namespace, or let Wix automatically generate one for you in the `"<ACTION_KEY>-<INDEX_OF_ACTION>"` format.

Here's an example of a trigger payload:

```json
{ 
  "intField": "50",
  "boolField": true
}
```

The trigger is followed by an action with the namespace `"action_1"`, that outputs the following data:

```json
{
  "message": "hello"
}
```

The payload sent to the step that follows the action looks like this:

```json
{ 
  "intField": "50",
  "boolField": true,
  "action_1": {
    "message": "hello"
  }
}
```

The output of any subsequent actions in the automation flow is concatenated to the payload. For example, given the following automation configuration:

```bash
Trigger A
    |
Action B // namespace = "action_b1"
    |
Action B // namespace = "action_b2"
    |
Action C
```

The payload available to Action C looks like this:

```json
{
  "intField": "50",
  "boolField": true,
  "action_b1": {
    "message": "hi there"
  },
  "action_b2": {
    "message": "hello"
  }
}
```

All the fields in the JSON above are available to Action C to map to its own input fields. Action C can select which action output to use by choosing `action_b1.message` or `action_b2.message`.

You can provide the namespace, or let Wix automatically generate one for you in an `"<ACTION_KEY>-<INDEX_OF_ACTION>"`.

### Action type

Actions are steps in the automation flow. Each action has a specific type that determines its behavior. When configuring an action, you must specify both its type and its corresponding information object, as shown in the table below:

| Action type | Description | Information object |
| ----------- | ----------- | ----------- |
| `APP_DEFINED` | An action created by an app. Available in the Automations Builder to users.| `appDefinedInfo` |
| `CONDITION` | A [condition](fallback::https://dev.wix.com/docs/sdk/backend-modules/automations/terminology#condition) that determines which action runs next.| `conditionInfo` |
| `DELAY` | A period of time that forces the automation to wait before executing the next step.| `delayInfo` |
| `RATE_LIMIT` | A rate-limiter stops the automation flow if the subsequent action reaches its maximum allowed executions.| `rateLimitInfo` |

#### App-defined action

When the action type is `APP_DEFINED`, include the `appDefinedInfo` object. You need the ID of the app that created the action, and the action's key. Both are defined in the app dashboard.

You also need to define the action's input mapping, which is the implementation of its [input schema](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/actions/about-the-action-input-schema) defined in the app dashboard.

Here's an example of an input mapping object:

```json
{
  "inputMapping": {
    "to": "payload.contact.email",
    "subject": "`Your registration to $eventName is confirmed`",
    "body": "`Hi $contact.name, you are confirmed for the event.`"
  }
}
```

You can configure your automation to skip the app-defined action if certain conditions are met. You can list up to 10 such conditions in the `skipConditionOrExpressionGroups` array. Conditions can be hard-coded or stored in variables specified in the payload, such as `true` or `boolFieldFromPayload`. A condition can also be expressed as a function.

The last parameter in `appDefinedInfo` is `postActionIds`. This is similar to the `rootActionIds` array, but instead of specifying actions that run in parallel after the trigger occurs, it specifying actions that run after the app-defined action.

Here's a complete example of an `appDefinedInfo` object:

```json
{
  "appDefinedInfo": {
    "appId": "c7438f41-3e15-41cd-90c5-f17213281cf3",
    "actionKey": "send-a-coupon",
    "inputMapping": {
      "to": "contact.email",
      "subject": "`Your rewards coupon!`",
      "body": "`Hi $contact.name, you've received a coupon from $payload.businessName.`"
    },
    "skipConditionOrExpressionGroups": [
      "notSentSeparateCoupon",
    ],
    "postActionIds": [
      "297b5ab6-2225-4f24-be65-af8efdd70062",
      "27fc1e3f-4e2e-4514-b969-60caa9dfd883"
    ]
  }
}
```

#### Condition action

When the action type is `CONDITION`, include the `conditionInfo` object.

Specify your conditions in the `orExpressionGroups` array. Conditions can be hard-coded, variables from a payload, or expressions. Examples: `true`, `boolFieldFromPayload`, or a function expression.

The action evaluates to true if at least one condition in the `orExpressionGroups` array evaluates to true.

Use the `truePostActionIds` array to specify the IDs of actions that run when the condition evaluates to `true`. Similarly, use the `falsePostActionIds` array to specify the IDs of actions that run when the condition evaluates to `false`.

Here's an example of a `conditionInfo` object:

```json
{
  "conditionInfo":{
    "orExpressionGroups":[
       {
        "operator":"OR",
        "booleanExpressions":[
          "holidayDeal",
          "payload.purchaseValue > 1000"
        ]
      }
    ],
    "truePostActionIds":[
      "71213b85-3bf9-4dd8-a210-5c08a37c5e56"
    ],
    "falsePostActionIds":[
      "82bc79c4-f3eb-45af-9773-463d9ebb7bc6"
    ]
  }
}
```

#### Delay action

When the action type is `DELAY`, use `offsetExpression` and `offsetTimeUnit` to specify the amount of time the automation waits before the following step. The wait time starts when the current action completes.

To define the wait time from a specific date, specify a value for `dueDateEpochExpression` in milliseconds passed since the Unix Epoch (1 January, 1970 UTC), such as `18238348023423`, `someEpochFromPayloadField`, or `contact.birthdate`.

Example:

```json
{
  "offsetExpression": 5,
  "offsetTimeUnit": "DAYS"
}
```

This delays the execution of the next step for 5 days from the time the action completes.

Example with a specified date:

```json
{
  "offsetExpression": 5,
  "offsetTimeUnit": "DAYS",
  "dueDateEpochExpression": "contact.birthdate"
}
```

This delays the execution of the next step for 5 days from the contact's birth date as specified in the payload.

The final parameter of `delayInfo` is the `postActionIds` array. Use it to specify the IDs of any actions you want to run in parallel after the delay ends.

#### Rate-limit action

When the action type is `RATE_LIMIT`, define the `rateLimitInfo` object.

Use `maxActivationsExpression` to define the maximum number of times the step in the automation flow can run. Its value can be hard-coded or stored in a variable. Examples: `1`, `maximumValue`.

Use `rateLimitDurationExpression` to define how long the rate limit remains active before it expires. Its value can be hard-coded or stored in a variable. Examples: `10`, `durationValue`. `rateLimitDurationTimeUnit` defines the time unit.

`uniqueIdentifierExpression` provides an ID that the rate limiter can use to count the number of times the action has run. An example of a unique identifier is `contact.id` specified in the payload.

To run actions after the rate-limit action, specify their IDs in the `postActionIds` array.

Here's an example of the a rate-limiter action:

```json
{
  "maxActivationsExpression": 5,
  "rateLimitDurationExpression": 10,
  "rateLimitDurationTimeUnit": "WEEKS",
  "uniqueIdentifierExpression": "contact.id",
  "postActionIds": [
    "56e2bfd5-2ad9-4c82-b7a4-3e75f74bf890",
    "0a34275c-457c-4779-9704-4992c5a0b3a5",
    "e15a6094-089e-40fb-9e74-edb8d610fbd8"
  ]
}
```

In this example, the number of times a step in the flow can run is limited to 5, counted based on a particular contact ID. This limit lasts 10 weeks and runs 3 actions after it completes.

## General automation configuration

You can control the general settings of the automation when it's added to a site. These settings are found in `automation.settings` and include hiding the automation, making it read-only, and disabling users' ability to delete and deactivate the automation.

In addition, the `automation.settings.actionSettings` object contains settings that apply specifically to actions. These settings let you make specific actions permanent and read-only, or prevent users from adding delays and conditions to the automation

Here's a full example of the settings object:

```json
{
  "settings":{
    "hidden":false,
    "readonly":true,
    "disableStatusChange":true,
    "actionSettings":{
      "readonlyActionIds":[
        "e2b76883-c90b-4f32-a488-cad5d27e0c66",
        "c82506cd-2312-48fd-a4a2-d7944ac67ac3"
      ],
      "disableConditionAddition":false
    }
  }
}
```

By default, all boolean settings in `automation.settings` are `false` and all arrays are empty. This means that, unless you define otherwise, any automation you create, as well as its actions, are viewable, editable, and deletable.

onAutomationDeleted( )