Synopsis

npm hookls[pkg]
npm hookadd<entity><url><secret>
npm hook update<id><url>[secret]
npm hookrm<id>

Example

Add a hook to watch a package for changes:

$npm hookadd lodash https://example.com/ my-shared-secret

Add a hook to watch packages belonging to the usersubstack:

$npm hookadd ~substack https://example.com/ my-shared-secret

Add a hook to watch packages in the scope@npm

$npm hookadd @npm https://example.com/ my-shared-secret

List all your active hooks:

$npm hookls

List your active hooks for thelodash package:

$npm hookls lodash

Update an existing hook's url:

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

Remove a hook:

$npm hookrm id-deadbeef

Description

Allows you to managenpm hooks, 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 hookid used byupdate andrm are the IDs listed innpm 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

Edit this page on GitHub

1 contributorethomson

Last edited byethomson onSeptember 21, 2020