Create a new integration
Start with guided setup in the command line
To create a new integration with the Netlify SDK, run the
create command using npm, pnpm, or yarn.
pnpm create @netlify/sdk@latest
yarn create @netlify/sdk
npm create @netlify/sdk@latest
Follow the prompts:
- Install the
- Supply integration information, this includes:
- A slug which is a unique identifier for your integration. This is used to create the package name, and once it’s set you can’t change it.
- A description that is a brief summary of the integration and its functionality. This will be displayed in the Netlify UI.
- The integration level your integration will work on: site, team, or team-and-site.
- Permission scopes that the integration needs to function properly.
- Select any boilerplate you want to use.
Need to install the following packages:
Ok to proceed? (y) y
? Where do you want to create the integration? (.)
? What is the slug of the integration? (e.g. my-integration)
? What level will this integration be installed on?
? Summarize what your integration does. This will be shown on the integration's card on the Integrations page.
? Which boilerplate should be included? (Use arrow keys)
? Which package manager do you want to use? (Use arrow keys)
? Select your permission scopes (space to select) (Press <space> to select, <a>
to toggle all, <i> to invert selection, and <enter> to proceed)
? Do you want to link a Netlify site to your integration? This
will help you test your integration and will be used to host
When the process completes, your selected directory will have the files you need to start building your integration:
│ ├── index.ts
| ├── ui
│ │ └── index.ts
integration.yaml- The integration configuration file. This is where you configure the integration name, description, and other metadata.
netlify.toml- The Netlify configuration file. This is where you configure the settings for your integration.
src/index.ts- The entrypoint for developing the integration.
src/ui/index.ts- The entrypoint for developing the integration’s UI. Note that the Netlify SDK creates this file only when the
uiboilerplate is selected.
Start with an integration template
To create an integration and deploy it in one step, you can use one of our pre-made integration templates. To start, we have a template that contains a build event handler but more templates are coming soon.
Select the Deploy to Netlify button in the section below and follow the steps in your browser to create a new integration. Netlify will automatically deploy and publish the template as a private integration when you complete the flow.
Build event handler
This template is a good starting point for integrations that need to respond to build events.
Depending on which template or boilerplate components you selected for your new integration, visit the component docs to continue developing the functionality for your integration:
To learn more about how users will discover and enable your integration, visit the following docs: