Airtable

Introduction#

The Orshot Airtable integration generates images, PDFs, and videos from Airtable records. Choose an Orshot template, map Airtable fields to template parameters, render one record or a full view, and write the generated file back into an Airtable attachment field.

Orshot supports two Airtable paths:

• Airtable extension: the first-class app for selecting templates, mapping fields, and rendering records from an Airtable base.
• Scripting extension: a lightweight script fallback for teams that prefer custom JavaScript.

Video Tutorial#

Tip: In Orshot, open any template's Automate panel and pick the Airtable tab for setup steps and your template's ID.

Actions Available#

• Direct Visual Generation: Generate images, PDFs, and videos from Airtable records using Studio or library templates
• Table Data Integration: Use column values as template modifications
• Attachment Storage: Store generated files directly in Airtable attachment fields
• Batch Processing: Generate files for multiple records in a selected view
• Template Selection: Search Studio and library templates, including older paginated Studio templates
• Use Case Filters: Quickly find templates for social, real estate, product, event, and certificate workflows
• Auto Mapping: Map common Airtable fields to matching template parameters automatically
• Custom Scripting: Use the fallback script when you need full JavaScript control

How to Use#

Option A: Airtable Extension#

1. Add the Orshot extension to your Airtable base.
2. Paste your Orshot API key from Workspace Settings → API Keys.
3. Select the Airtable table and view to render.
4. Select an output Attachment field.
5. Choose an Orshot Studio or library template.
6. Search templates or use a workflow filter if needed.
7. Map each template parameter to an Airtable field, attachment field, or static value.
8. Use Auto-map fields to pre-fill common mappings such as title, image, price, address, and URL.
9. Click Render records.

The extension renders each record and writes the generated file URL back to the configured attachment field.

Option B: Scripting Extension#

Use this route if you want a small custom script instead of installing the Orshot extension.

1. Create Table Structure#

Create two columns in your Airtable table:

• Orshot Image (Type: Attachment) - stores the generated file
• Orshot Generate (Type: Button) - optional trigger for manual generation

2. Install Scripting Extension#

1. Click on the Extensions tab in your Airtable base.
2. Search for Scripting and install the extension.
3. Open the scripting interface.

3. Add the Script#

1. Copy the provided script code (see below)
2. Paste it into the Scripting extension
3. Update the <TABLE_NAME> with your actual table name
4. Update the <OUTPUT_COLUMN_NAME> with "Orshot Image"
5. Replace <YOUR_API_KEY> with your actual Orshot API key

4. Configure Template and Modifications#

1. Set the templateId to your desired Studio template ID (e.g., 25)
2. Customize the modifications object to map your table columns:

   "canvasBackgroundColor": record.getCellValue('canvasBackgroundColor'),
   "main-headline": record.getCellValue('main-headline'),
   "sub-headline": record.getCellValue('sub-headline'),
   "app-screenshot": record.getCellValue('app-screenshot'),
   "cta-text": record.getCellValue('cta-text')

5. Generate Images#

1. Save the script in the Scripting extension
2. Click the "Orshot Generate" button in any table row
3. The script will run and generate a file based on that record's data
4. The generated file will be stored in the "Orshot Image" column

Sample Script Code#

const table = base.getTable("<TABLE_NAME>");
const record = await input.recordAsync("Pick a record", table);
const requestData = {
  templateId: 25,
  modifications: {
    canvasBackgroundColor: record.getCellValue("canvasBackgroundColor"),
    "main-headline": record.getCellValue("main-headline"),
    "sub-headline": record.getCellValue("sub-headline"),
    "app-screenshot": record.getCellValue("app-screenshot"),
    "cta-text": record.getCellValue("cta-text"),
  },
  response: {
    type: "url",
    format: "png",
    scale: 1,
  },
};

const response = await fetch("https://api.orshot.com/v1/studio/render", {
  method: "POST",
  body: JSON.stringify(requestData),
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const responseData = await response.json();
await table.updateRecordAsync(record.id, {
  "<OUTPUT_COLUMN_NAME>": [{ url: responseData.data.content }],
});

Need Help?#

• Contact support at hi@orshot.com or use chat button in your Orshot dashboard for assistance