Connectors overview
Use connectors to develop extensions that add support for a custom data source to Netlify Connect, Netlify Visual Editor, or both. Once published, we often refer to these extensions as data integrations.
When you create an extension using a connector, you develop the functionality that Netlify will use to sync data from your third-party or proprietary data source to Connect and the visual editor.
Specifically, you use the Connector APIs and extension UI to:
- define the data model for your data source type
- specify how to store and update data on Netlify whenever data changes
- for the visual editor, specify how to write data and upload assets to your data source, and customize editor settings
- specify the configuration options that will appear in the Netlify UI for Connect and visual editor users
You can use the Netlify SDK commands to run, test, and build your extension as you work.
Once you finish development, you can publish your extension for Connect and visual editor users to select, configure, and use in their data layers.
Documentation
- Get started: a high-level guide on how to install the Netlify SDK, generate the boilerplate files, and add code for a basic connector example.
- Develop: detailed information on the steps to develop a connector that supports your data source type.
- Build: information on how to build your connector.
- Debug and test: an overview of how to debug and write tests for your connector code.