ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / local / n / versions / node / 12.14.1 / lib / node_modules / npm / docs / content / cli-commands

---
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)

[-] npm-build.md [edit]
[-] npm-bundle.md [edit]
[-] npm-prune.md [edit]
[-] npm-repo.md [edit]
[-] npm-owner.md [edit]
[-] npm-edit.md [edit]
[-] npm-audit.md [edit]
[-] npm-unpublish.md [edit]
[-] npm-bin.md [edit]
[-] npm-test.md [edit]
[-] npm-run-script.md [edit]
[-] npm-completion.md [edit]
[-] npm-adduser.md [edit]
[+] ..
[-] npm-deprecate.md [edit]
[-] npm-link.md [edit]
[-] npm-root.md [edit]
[-] npm-dist-tag.md [edit]
[-] npm-update.md [edit]
[-] npm-start.md [edit]
[-] npm-config.md [edit]
[-] npm-hook.md [edit]
[-] npm-token.md [edit]
[-] npm-pack.md [edit]
[-] npm-stars.md [edit]
[-] npm-publish.md [edit]
[-] npm-whoami.md [edit]
[-] npm-install-ci-test.md [edit]
[-] npm-prefix.md [edit]
[-] npm-shrinkwrap.md [edit]
[-] npm.md [edit]
[-] npm-install-test.md [edit]
[-] npm-version.md [edit]
[-] npm-team.md [edit]
[-] npm-fund.md [edit]
[-] npm-restart.md [edit]
[-] npm-star.md [edit]
[-] npm-ci.md [edit]
[-] npm-ls.md [edit]
[-] npm-explore.md [edit]
[-] npm-view.md [edit]
[-] npm-dedupe.md [edit]
[-] npm-cache.md [edit]
[-] npm-uninstall.md [edit]
[-] npm-ping.md [edit]
[-] npm-install.md [edit]
[-] npm-access.md [edit]
[-] npm-help-search.md [edit]
[-] npm-help.md [edit]
[-] npm-org.md [edit]
[-] npm-init.md [edit]
[-] npm-logout.md [edit]
[-] npm-doctor.md [edit]
[-] npm-stop.md [edit]
[-] npm-bugs.md [edit]
[-] npm-rebuild.md [edit]
[-] npm-docs.md [edit]
[-] npm-profile.md [edit]
[-] npm-outdated.md [edit]
[-] npm-search.md [edit]