Executing FileMaker scripts via the Data API

Expert

Trigger server-side FileMaker scripts from the Data API, pass parameters, and read script results.

What you'll learn

How to run a script alongside a record request using script parameters
How to use the standalone script execution endpoint
How to pass parameters and retrieve script results

The Data API can trigger FileMaker scripts in three ways: alongside a record operation (pre, post, or as part of a request), or as a standalone script execution endpoint. This allows external systems to kick off complex server-side workflows and retrieve results without navigating the full CRUD interface.

1/3

Script alongside a record operation

Add script, script.param, script.prerequest, and script.presort parameters to any record request to trigger scripts before or after the data operation.

JSON

POST /fmi/data/v1/databases/MyDB/layouts/Invoices/records

{
  "fieldData": { "Status": "Paid", "PaidAt": "01/15/2025 10:30:00" },
  "script": "Send Payment Receipt",
  "script.param": "{"invoiceId": 42, "sendEmail": true}"
}

Portal data in Data API responses Data API token management and session reuse