Create and edit a module interface to control which source data and functions are exposed for syncing to a target database

To create a module interface

A module interface defines which tables, fields, and permissions are exposed from the source database so they can be used in a target database.

1. From workspace home, click the card of the source database.
2. Toggle on Edit mode.
3. In the left navigation panel, next to the database name, click the ellipsis (…) button.
4. From the menu, select Module settings.
5. Click the Configure public fields button.
6. In the dialog, in the upper left corner, select a table or page from the menu.
7. Select the fields you want to expose.
8. By default, each field's permission is set to Read only. To allow users to overwrite source data with data from the target database, select the Read and write radio button instead.
9. To set record permissions for each table or page, check the boxes Create and/or Delete in the upper right corner of the dialog.
10. When you're done, click the Save button.
11. Back on the Module settings page, enter an interface name and click the Save button.
12. Reconfirm by clicking the Save interface button in the dialog.

⚠️ Warning: Your interface name is an API-level identifier, which means changing the name later bumps the interface version automatically, breaking connections, and asking users to update to the new version. Since an interface name also identifies an available interface in a source database, choose a name that's easy to read and that describes the module's purpose.

✅ Tip: Expose only what users really need—fewer sync points mean fewer surprises. Grant Write access sparingly; once enabled, users can overwrite your source data.

To expose global functions in a module interface

Expose global functions to make them available in the target database when using the module.

1. If you already created a module interface, click the Edit button on the Module settings page. Otherwise, follow the steps above to create an interface first.
2. Click the Configure public functions button.
3. In the dialog, select all global functions you want to expose.
4. By default, each global function is run in the source database. To run a global function in the target database, select the Target radio button instead.
5. When you're done, click the Save button.
6. Back on the Module settings page, click the Save button.
7. Reconfirm by clicking the Save interface button in the dialog.

To edit a module interface

Edit a module interface to update its name, exposed fields, exposed global functions, or permissions.

1. From workspace home, click the card of the source database.
2. Toggle on Edit mode.
3. Open Module settings.
4. Next to the interface you want to update, click Edit.
5. Make your changes as needed:
   • To update exposed fields, click Configure public fields.
   • To update exposed global functions, click Configure public functions.
6. Click the Save button.
7. Reconfirm by clicking the Save interface button in the dialog.

Related articles

• Connecting a module to an existing table or a new table
• Calculated fields in modules
• Relationship fields in modules
• Removing exposed data from a module interface
• Deleting a module interface