--- section: cli-commands title: npm-hook description: Manage registry hooks --- # npm-hook(1) ## Manage registry hooks ### Synopsis ```bash npm hook ls [pkg] npm hook add <entity> <url> <secret> npm hook update <id> <url> [secret] npm hook rm <id> ``` ### 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 ``` ### 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. ### See Also * ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
npm-access.md | File | 2.87 KB | 0644 |
|
npm-adduser.md | File | 2.93 KB | 0644 |
|
npm-audit.md | File | 4.08 KB | 0644 |
|
npm-bin.md | File | 452 B | 0644 |
|
npm-bugs.md | File | 1.08 KB | 0644 |
|
npm-build.md | File | 645 B | 0644 |
|
npm-bundle.md | File | 416 B | 0644 |
|
npm-cache.md | File | 2.73 KB | 0644 |
|
npm-ci.md | File | 1.92 KB | 0644 |
|
npm-completion.md | File | 936 B | 0644 |
|
npm-config.md | File | 1.62 KB | 0644 |
|
npm-dedupe.md | File | 1.44 KB | 0644 |
|
npm-deprecate.md | File | 953 B | 0644 |
|
npm-dist-tag.md | File | 2.95 KB | 0644 |
|
npm-docs.md | File | 1.14 KB | 0644 |
|
npm-doctor.md | File | 4.65 KB | 0644 |
|
npm-edit.md | File | 1.07 KB | 0644 |
|
npm-explore.md | File | 1.04 KB | 0644 |
|
npm-fund.md | File | 1.59 KB | 0644 |
|
npm-help-search.md | File | 910 B | 0644 |
|
npm-help.md | File | 989 B | 0644 |
|
npm-hook.md | File | 1.88 KB | 0644 |
|
npm-init.md | File | 2.17 KB | 0644 |
|
npm-install-ci-test.md | File | 438 B | 0644 |
|
npm-install-test.md | File | 832 B | 0644 |
|
npm-install.md | File | 19.03 KB | 0644 |
|
npm-link.md | File | 2.75 KB | 0644 |
|
npm-logout.md | File | 1.28 KB | 0644 |
|
npm-ls.md | File | 2.57 KB | 0644 |
|
npm-org.md | File | 1.01 KB | 0644 |
|
npm-outdated.md | File | 3.86 KB | 0644 |
|
npm-owner.md | File | 1.22 KB | 0644 |
|
npm-pack.md | File | 1.01 KB | 0644 |
|
npm-ping.md | File | 519 B | 0644 |
|
npm-prefix.md | File | 678 B | 0644 |
|
npm-profile.md | File | 2.89 KB | 0644 |
|
npm-prune.md | File | 1.38 KB | 0644 |
|
npm-publish.md | File | 3.12 KB | 0644 |
|
npm-rebuild.md | File | 495 B | 0644 |
|
npm-repo.md | File | 774 B | 0644 |
|
npm-restart.md | File | 962 B | 0644 |
|
npm-root.md | File | 438 B | 0644 |
|
npm-run-script.md | File | 3.49 KB | 0644 |
|
npm-search.md | File | 2.85 KB | 0644 |
|
npm-shrinkwrap.md | File | 1004 B | 0644 |
|
npm-star.md | File | 591 B | 0644 |
|
npm-stars.md | File | 614 B | 0644 |
|
npm-start.md | File | 798 B | 0644 |
|
npm-stop.md | File | 452 B | 0644 |
|
npm-team.md | File | 2.2 KB | 0644 |
|
npm-test.md | File | 469 B | 0644 |
|
npm-token.md | File | 2.8 KB | 0644 |
|
npm-uninstall.md | File | 1.53 KB | 0644 |
|
npm-unpublish.md | File | 1.45 KB | 0644 |
|
npm-update.md | File | 3.39 KB | 0644 |
|
npm-version.md | File | 4.47 KB | 0644 |
|
npm-view.md | File | 3.19 KB | 0644 |
|
npm-whoami.md | File | 385 B | 0644 |
|
npm.md | File | 5.31 KB | 0644 |
|