Create, update, or delete a module interface to control which data consumers can sync—and which permissions they have

To create a module interface

1. From workspace home, click the card of the provider database.
2. Toggle on Edit mode.
3. In the left navigation panel, on the right side of the database name, click the ellipsis button.
4. From the menu, select Module settings.
5. In the Configure public fields dialog: in the top-left corner, select a table from the menu.
6. Select the fields you want to expose.
7. Optional, for each field: give consumers permission to overwrite your source data by toggling on Write.
8. Optional, for each table: set record permissions by checking Create and/or Delete.
9. When you're done, click the Save button.
10. Reconfirm by clicking the Save button in the dialog.
11. On the Module settings page, click the Configure public fields button.
12. Back on the Module settings page, enter an interface ID and click the Save interface button.

⚠️ Warning: Your interface ID is an API-level identifier, which means changing the the ID later bumps the interface version automatically, breaking connections, and asking consumers to update to the new version. Since interface IDs also used to identify available interfaces in authors' databases, make sure to choose a human-readable name that describes the module's purpose.

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

To edit a module interface

1. Navigate to the Module settings page and click the Edit interface button.
2. Now you can:
   1. Add new fields to be exposed or remove exposed fields. Access the Configure public fields dialog and follow the same steps as for creating an interface.
   2. Update the interface ID by clicking the Edit interface button.

To delete a module interface

1. Navigate to the Module settings page and click the Delete button.
2. Reconfirm by clicking the Delete interface button in the dialog.

ℹ️ Note: Unselecting all previously exposed fields in the Configure public fields dialog and saving your changes automatically deletes your module interface.