Run a script Action

When building an Automation, you may choose the "Run a script" action. When an automation containing a "Run a script" action runs successfully, it will allow you to trigger a script based on record changes, a form submission, using the Airtable API, and more.

Overview

An automation's scripting action runs a script in the background of the base. This differs from the Scripting app which runs a script in the foreground. For scripts that you would rather run manually the Scripting app is the ideal tool. For scripts that you would like to run automatically, setting up a scripting automation is the best choice.

Prerequisites

• This action is only available on the Pro and Enterprise plans. It is not available on the Pro Trial, Plus, Free, Creator, or Student plans.
• Scripting action does not support interactive input and output. Unlike scripting block, scripting action does not have the ability to display a form or pop up a message.
• The input and output APIs from the scripting block are not currently available.
  • Automations scripts have different, simpler input/output APIs. The input/output APIs in the "Run script" action can not intake user input, but they can input variables for your script to use, and output data from your script for later steps in your API. 
    • The output API can currently return a maximum of 6MB of data. 
• Scripts need to finish in under 30 seconds
  • API calls timeout at 12 seconds
• Scripts can use 512mb of memory
• Scripts can make 50 fetch requests and 30 selectRecords queries.
• Scripts can make up to 15 mutations a second. A mutation is creating, updating, or deleting records. Each mutation can change up to 50 records at once.

Need help gathering your ideas? Consider these options:

• Explore the "Example Script Showcase" in the Airtable Universe
• Visit the Airtable community scripting page
• Check out our Scripting documentation for examples of Scripts. 

Setup

To get started, create your desired Airtable base. In this example, we are creating a simple script that will add the value of two fields together with the result of the calculation appearing in a third field. The script used in this example looks like this:

let table = base.getTable('Calculation');
let query = await table.selectRecordsAsync({fields: table.fields});
for (let record of query.records) {
  let firstnumber = record.getCellValue('First Number');
  let secondnumber = record.getCellValue('Second Number');
  let calculation = firstnumber + secondnumber;
  await table.updateRecordAsync(record, {
    "Addition": calculation
  });
}

Values specific to your particular base appear in color. The red value is the name of the table the script is referencing. The blue values reference the various number field names you are looking to add together. Finally, the green value represents the field that is being updated with the result of your calculation. For more information on internal Airtable classes that can bed accessed via your script—check out our API reference documentation.  

Open the Automations panel and create an automation. Then, choose a trigger, such as "When a record enters a view". In our example, the view was filtered to only show records that have values in the "First Number" and "Second Number" fields. After proper setup, test your trigger by clicking "Run test".

After testing the trigger successfully, we can move onto setting up the action. Click the blue "+ Add Action" button. Then, click on the "Run a script" option. This will bring up a window for editing your script's code. After you have written or copy and pasted your code into the console, click the blue test button to make sure your code does not have any errors.

After the script action tests successfully you can proceed with toggling on the automation in the upper right-hand corner of the automations console. Notice, the values are automatically calculated after both the first and second numbers have been entered.

Automation URLs

Starting on January 25th 2022, Airtable made a change to URL formatting in Automation triggers and actions. Now, the base ID (appXXXXXXXXXXXXXX) will appear at the start of the URL path. This change coincides with the recent change to include base IDs in Airtable URLs throughout the rest of product. The change in record URL format will occur in these places:

• The url property of a record output by a trigger/action.
• The url property of a Table or View model retrieved by the Run Script action.

This may be a breaking change if your automation makes hard assumptions about the format of a URL property (e.g. by deconstructing the returned URL into its component parts or similar). No action should be needed if your automation only uses the URL for navigational purposes. Browser navigation will continue to work for the old-style Airtable URLs via redirects, although these redirects may not be supported indefinitely in the future. If your automation constructs Airtable URLs from scratch, we recommend updating the construction logic to also include the base ID.

FAQs

How is the Automations scripting action different from scripting block?

Scripting block scripts run in the foreground of the base. They’re triggered directly by a user, who is then able to see any output from the script and add any additional input the script asks for. They’re ideal for automating workflows that require some human involvement.

Automations scripting action scripts run in the background of the base. They’re triggered indirectly, and run automatically behind the scenes while the user keeps working. They’re ideal as an escape hatch for when our other automation actions don’t support something, or for advanced automations use-cases.

Will the script run even if my base is not open?

Yes. Once enabled, the script will run when a record enters the view, regardless of whether the base is open. This allows you to schedule when a script runs, or trigger a script based a form submission or by using the Airtable API to create or edit a record.

What APIs can I access using the Automations scripting action?

You can access any API – post a tweet on Twitter, or use the Airtable API to make a change in another Airtable base. Unlike scripting block, there is no core origin resources sharing (CORS) limitation. 

Can I set up a script to run on a schedule using Automations?

Yes, it is possible to set a script to run on a schedule using the "At a scheduled time" trigger. Learn more here.