Skip to content
Netlify SDK Docs Netlify SDK Docs 1.0.4

Introduction

Welcome to the Netlify SDK, the toolset for developing Netlify Integrations.

Integration use cases

Netlify Integrations extend the capabilities of the Netlify platform and streamline developer workflows. For example:

  • Custom data source for Netlify Connect. Connect to and sync data from any data source including both third-party services and proprietary solutions.
  • Content generation. Create sitemaps, RSS feeds, or search indexes as part of the build process.
  • Quality assurance. Check for broken links in a site after the build completes but before the site is deployed.
  • Runtime observability. Monitor serverless function activity with an integration wrapper.
  • Installation process automation. Simplify the workflow for developers using your service with Netlify by doing things like generating required environment variables automatically instead of asking users to set them manually.

These are just a few examples of how you can accelerate your business through Netlify Integrations built with the Netlify SDK.

Integration architecture

As an integration developer, you create and make available an integration that Netlify users then install on their sites or teams.

An integration includes one or more of the following components:

  • Connectors: connect to and sync data from a custom data source to Netlify Connect.
  • Build Event Handlers: run JavaScript code in response to different events in Netlify’s build-deploy lifecycle.
  • API Handlers: use serverless functions to perform dynamic actions.
  • Integration UI: provide an interactive surface in the Netlify app where users can configure and provide context for your integration.

The Connectors component is typically used on its own to make integrations for Netlify Connect.

The Build Event Handlers, API Handlers, and Integration UI components are typically used together to make integrations for the rest of the Netlify platform.

Integration availability

Publishing:

  • To contribute to the composable architecture ecosystem, you can publish Partner Integrations through our technology partner program for other Netlify users to enjoy.
  • You can publish integrations for Netlify Connect as Private Connectors for only your Netlify team to use.
  • In the future, it will also be possible to publish Private Integrations for all other propriety systems and solutions.

Pricing:

  • The Netlify SDK is available to all team plans for building integrations.
  • Netlify Integrations that are published in the Netlify UI are available to all team plans for installation.
  • However, you can build integrations that interact with features that are only available on certain team plans. For example, the Connectors component integrates with Netlify Connect, which is only available on Enterprise plans.

SDK workflow

Here’s a typical workflow for developing an integration with the Netlify SDK:

  1. Create a new integration with the Netlify SDK CLI to get boilerplate files for the components you want to use in your integration.
  2. Customize the generated code to add Connectors, Build Event Handlers, API Handlers, or Integration UI, and tailor them to the goals of your integration.
  3. Customize the authentication and enablement flow to fit the needs of your integration.
  4. Test and debug your integration to make sure it’s working as intended.
  5. Build your integration to get it ready for publishing.
  6. Start the process of publishing your integration.

Next steps