Gecko [ c.stage.kornherr.net ]

Name	Size	Permission	Date
npm-access.md	2.56 KB	-rw-r--r--	2022-12-07 23:13
npm-adduser.md	832 B	-rw-r--r--	2022-12-07 23:13
npm-audit.md.gz	3.33 KB	-rw-r--r--	2022-12-07 23:13
npm-bugs.md	840 B	-rw-r--r--	2022-12-07 23:13
npm-cache.md	2.73 KB	-rw-r--r--	2022-12-07 23:13
npm-ci.md	2.07 KB	-rw-r--r--	2022-12-07 23:13
npm-completion.md	924 B	-rw-r--r--	2022-12-07 23:13
npm-config.md	2.13 KB	-rw-r--r--	2022-12-07 23:13
npm-dedupe.md	2.13 KB	-rw-r--r--	2022-12-07 23:13
npm-deprecate.md	1.31 KB	-rw-r--r--	2022-12-07 23:13
npm-diff.md.gz	1.98 KB	-rw-r--r--	2022-12-07 23:13
npm-dist-tag.md	3.2 KB	-rw-r--r--	2022-12-07 23:13
npm-docs.md	820 B	-rw-r--r--	2022-12-07 23:13
npm-doctor.md.gz	2.16 KB	-rw-r--r--	2022-12-07 23:13
npm-edit.md	922 B	-rw-r--r--	2022-12-07 23:13
npm-exec.md.gz	3.3 KB	-rw-r--r--	2022-12-07 23:13
npm-explain.md	1.81 KB	-rw-r--r--	2022-12-07 23:13
npm-explore.md	880 B	-rw-r--r--	2022-12-07 23:13
npm-find-dupes.md	511 B	-rw-r--r--	2022-12-07 23:13
npm-fund.md	1.93 KB	-rw-r--r--	2022-12-07 23:13
npm-help-search.md	693 B	-rw-r--r--	2022-12-07 23:13
npm-help.md	840 B	-rw-r--r--	2022-12-07 23:13
npm-hook.md	1.87 KB	-rw-r--r--	2022-12-07 23:13
npm-init.md.gz	1.92 KB	-rw-r--r--	2022-12-07 23:13
npm-install-ci-test.md	437 B	-rw-r--r--	2022-12-07 23:13
npm-install-test.md	497 B	-rw-r--r--	2022-12-07 23:13
npm-install.md.gz	4.73 KB	-rw-r--r--	2022-12-07 23:13
npm-link.md	3.95 KB	-rw-r--r--	2022-12-07 23:13
npm-login.md	1.15 KB	-rw-r--r--	2022-12-07 23:13
npm-logout.md	949 B	-rw-r--r--	2022-12-07 23:13
npm-ls.md	3.09 KB	-rw-r--r--	2022-12-07 23:13
npm-org.md	1.01 KB	-rw-r--r--	2022-12-07 23:13
npm-outdated.md	3.77 KB	-rw-r--r--	2022-12-07 23:13
npm-owner.md	1.25 KB	-rw-r--r--	2022-12-07 23:13
npm-pack.md	948 B	-rw-r--r--	2022-12-07 23:13
npm-ping.md	726 B	-rw-r--r--	2022-12-07 23:13
npm-pkg.md.gz	1.8 KB	-rw-r--r--	2022-12-07 23:13
npm-prefix.md	839 B	-rw-r--r--	2022-12-07 23:13
npm-profile.md	2.9 KB	-rw-r--r--	2022-12-07 23:13
npm-prune.md	1.32 KB	-rw-r--r--	2022-12-07 23:13
npm-publish.md	3.58 KB	-rw-r--r--	2022-12-07 23:13
npm-query.md	2.84 KB	-rw-r--r--	2022-12-07 23:13
npm-rebuild.md	764 B	-rw-r--r--	2022-12-07 23:13
npm-repo.md	613 B	-rw-r--r--	2022-12-07 23:13
npm-restart.md	920 B	-rw-r--r--	2022-12-07 23:13
npm-root.md	686 B	-rw-r--r--	2022-12-07 23:13
npm-run-script.md.gz	1.72 KB	-rw-r--r--	2022-12-07 23:13
npm-search.md	1.56 KB	-rw-r--r--	2022-12-07 23:13
npm-shrinkwrap.md	938 B	-rw-r--r--	2022-12-07 23:13
npm-star.md	1007 B	-rw-r--r--	2022-12-07 23:13
npm-stars.md	690 B	-rw-r--r--	2022-12-07 23:13
npm-start.md	1.09 KB	-rw-r--r--	2022-12-07 23:13
npm-stop.md	791 B	-rw-r--r--	2022-12-07 23:13
npm-team.md	2.96 KB	-rw-r--r--	2022-12-07 23:13
npm-test.md	667 B	-rw-r--r--	2022-12-07 23:13
npm-token.md	3.31 KB	-rw-r--r--	2022-12-07 23:13
npm-uninstall.md	1.64 KB	-rw-r--r--	2022-12-07 23:13
npm-unpublish.md	1.47 KB	-rw-r--r--	2022-12-07 23:13
npm-unstar.md	866 B	-rw-r--r--	2022-12-07 23:13
npm-update.md	3.86 KB	-rw-r--r--	2022-12-07 23:13
npm-version.md	3.64 KB	-rw-r--r--	2022-12-07 23:13
npm-view.md	3.3 KB	-rw-r--r--	2022-12-07 23:13
npm-whoami.md	755 B	-rw-r--r--	2022-12-07 23:13
npm.md.gz	2.36 KB	-rw-r--r--	2022-12-07 23:13
npx.md.gz	2.16 KB	-rw-r--r--	2022-12-07 23:13

Rename

---
title: npm-hook
section: 1
description: Manage registry hooks
---

### Synopsis

Note: This command is unaware of workspaces.

### Description

Allows you to manage [npm
hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
including adding, removing, listing, and updating.

Hooks allow you to configure URL endpoints that will be notified whenever a
change happens to any of the supported entity types. Three different types
of entities can be watched by hooks: packages, owners, and scopes.

To create a package hook, simply reference the package name.

To create an owner hook, prefix the owner name with `~` (as in,
`~youruser`).

To create a scope hook, prefix the scope name with `@` (as in,
`@yourscope`).

The hook `id` used by `update` and `rm` are the IDs listed in `npm hook ls`
for that particular hook.

The shared secret will be sent along to the URL endpoint so you can verify
the request came from your own configured hook.

### Example

Add a hook to watch a package for changes:

```bash
$ npm hook add lodash https://example.com/ my-shared-secret
```

Add a hook to watch packages belonging to the user `substack`:

```bash
$ npm hook add ~substack https://example.com/ my-shared-secret
```

Add a hook to watch packages in the scope `@npm`

```bash
$ npm hook add @npm https://example.com/ my-shared-secret
```

List all your active hooks:

```bash
$ npm hook ls
```

List your active hooks for the `lodash` package:

```bash
$ npm hook ls lodash
```

Update an existing hook's url:

```bash
$ npm hook update id-deadbeef https://my-new-website.here/
```

Remove a hook:

```bash
$ npm hook rm id-deadbeef
```

### Configuration

### See Also

* ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)