Skip to content
Netlify SDK DocsNetlify SDK Docs1.13.2

Requirements and limitations

Keep these requirements and limitations in mind when using the Netlify SDK to build an integration.

Requirements

Netlify integrations are written in Node.js.

  • The SDK requires Node.js 18 or later.
  • Your project’s root directory must have a package.json file. If you use npm create @netlify/sdk to create your integration, this file is automatically generated for you.

Netlify integrations are written in TypeScript.

  • Your project’s root directory must have a tsconfig.json file. If you use npm create @netlify/sdk to create your integration, this file is automatically generated for you.

Local development and testing of integrations with Connectors require the Netlify SDK utility tools

  • Install the Netlify SDK utility tools by running npm install -g @netlify/sdk.

Local development and testing of all other integrations also require the Netlify CLI.

  • Install the Netlify CLI by running npm install -g netlify-cli.

Local development and testing of integrations with Build Event Handlers require the integration to be linked to a site.

  • You will be given the option to link your integration to a site when you run npm create @netlify/sdk to create your integration.
  • If you choose not to link your integration to a site when you create it, you can link it later by running netlify link.

Limitations

End-to-end testing in a Netlify site is not supported yet.

  • It’s currently only possible to test your integration locally.
  • If you want to test your integration in a Netlify site, reach out through our technology partner program and we will work with you to test your integration.