# sanity-plugin-dashboard-widget-netlify

> Sanity Studio Dashboard Widget for triggering Netlify builds

Latest version **3.0.22** (published 2026-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install sanity-plugin-dashboard-widget-netlify
pnpm add sanity-plugin-dashboard-widget-netlify
yarn add sanity-plugin-dashboard-widget-netlify
bun add sanity-plugin-dashboard-widget-netlify
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.22 |
| Published | 2026-10-13 |
| First published | 2019-03-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=20.19 <22 \|\| >=22.12 |
| Dependencies | 1 |
| Unpacked size | 36 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 20 |
| Author | Sanity.io <hello@sanity.io> |
| Maintainers | skogsmaskin, mariuslundgard, sanity-svc.npm, sanity-io |
| Keywords | dashboard, netlify, plugin, sanity, widget |

## Links

- npm: https://www.npmjs.com/package/sanity-plugin-dashboard-widget-netlify
- Repository: https://github.com/sanity-io/plugins
- Homepage: https://github.com/sanity-io/plugins/tree/main/plugins/sanity-plugin-dashboard-widget-netlify#readme
- Issues: https://github.com/sanity-io/plugins/issues
- npm.io page: https://npm.io/package/sanity-plugin-dashboard-widget-netlify

## Dependencies (1)

- [@sanity/ui](https://npm.io/package/@sanity/ui.md) ^4.4.5

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.0.22 (latest) — 2026-10-13
- 1.3.2 (studio-v2) — 2022-11-22
- 2.0.0-v3-studio.7 (studio-v3) — 2022-11-04
- 3.0.21 — 2026-10-12
- 3.0.20 — 2026-10-09
- 3.0.19 — 2026-09-29
- 3.0.18 — 2026-08-21
- 3.0.17 — 2026-08-20
- 3.0.16 — 2026-08-11
- 3.0.15 — 2026-08-10
- 3.0.14 — 2026-07-23
- 3.0.13 — 2026-07-22
- 3.0.12 — 2026-07-17
- 3.0.11 — 2026-07-16
- 3.0.10 — 2026-07-14
- … 38 more at https://npm.io/package/sanity-plugin-dashboard-widget-netlify/versions

## README

# Sanity Dashboard Widget: Netlify

Sanity Studio Dashboard Widget for triggering Netlify builds.

## Install

```
npm install --save sanity-plugin-dashboard-widget-netlify
```

or

```
yarn add sanity-plugin-dashboard-widget-netlify
```

Ensure that you have followed install and usage instructions for [@sanity/dashboard](https://github.com/sanity-io/dashboard).

## Usage

Add it as a widget to @sanity/dashboard plugin in sanity.config.ts (or .js):

```js
import {dashboardTool} from '@sanity/dashboard'
import {netlifyWidget} from 'sanity-plugin-dashboard-widget-netlify'

export default defineConfig({
  // ...
  plugins: [
    dashboardTool({
      widgets: [
        netlifyWidget({
          title: 'My Netlify deploys',
          sites: [
            {
              title: 'Sanity Studio',
              apiId: 'xxxxx-yyyy-zzzz-xxxx-yyyyyyyy',
              buildHookId: 'xxxyyyxxxyyyyxxxyyy',
              name: 'sanity-gatsby-blog-20-studio',
            },
            {
              title: 'Website',
              apiId: 'yyyyy-xxxxx-zzzz-xxxx-yyyyyyyy',
              buildHookId: 'yyyyxxxxxyyyxxdxxx',
              name: 'sanity-gatsby-blog-20-web',
              url: 'https://my-sanity-deployment.com',
            },
          ],
        }),
      ],
    }),
  ],
})
```

### Widget options

`title` - Override the widget default title

`sites[]` - Your Netlify sites to show deploys for

- `apiId`- The Netfliy API ID of your site (see _Site Settings > General > Site Details > Site Information -> API ID_).
- `buildHookId` - The id of a build hook you have created for your site within the Netlify administration panel (see _Site Settings > Build & Deploy > Continuous Deployment -> Build Hooks_).
- `name` - The Netlify site name
- `title` - Override the site name with a custom title
- `url` - Optionally override site deployment url. By default it is inferred to be `https://netlify-site-name.netlify.app`.
- `branch` - Optionally pass the name of a branch to deploy

## License

MIT-licensed. See LICENSE.

---
_Source: https://npm.io/package/sanity-plugin-dashboard-widget-netlify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._