# sphooks

> Cross-platform CLI for managing SharePoint list web hooks

Latest version **0.0.5** (published 2017-11-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install sphooks
pnpm add sphooks
yarn add sphooks
bun add sphooks
```

Provides the command `sphooks`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2017-11-01 |
| First published | 2017-08-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Sergei Sergeev |
| Maintainers | s-kainet |
| Keywords | sharepoint, authentication, nodejs, web hooks |

## Links

- npm: https://www.npmjs.com/package/sphooks
- Repository: https://github.com/s-KaiNet/sphooks
- Issues: https://github.com/s-KaiNet/sphooks/issues
- npm.io page: https://npm.io/package/sphooks

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^2.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^3.2.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [commander](https://npm.io/package/commander.md) ^2.11.0
- [sp-pnp-js](https://npm.io/package/sp-pnp-js.md) ^3.0.1
- [node-pnp-js](https://npm.io/package/node-pnp-js.md) ^0.1.0
- [preferences](https://npm.io/package/preferences.md) ^0.2.1
- [node-sp-auth](https://npm.io/package/node-sp-auth.md) ^2.2.9

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 0.0.5 (latest) — 2017-11-01
- 0.0.4 — 2017-10-08
- 0.0.3 — 2017-08-16
- 0.0.2 — 2017-08-16
- 0.0.1 — 2017-08-16

## README

# sphooks - cross-platform CLI for managing SharePoint list web hooks

[![NPM](https://nodei.co/npm/sphooks.png?mini=true)](https://nodei.co/npm/sphooks/)
[![npm version](https://badge.fury.io/js/sphooks.svg)](https://badge.fury.io/js/sphooks)

### Need help on SharePoint with Node.JS? Join our gitter chat and ask question! [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/sharepoint-node/Lobby)

Built with Node.JS, Typescript, [sp-pnp-js](https://github.com/SharePoint/PnP-JS-Core) and [node-sp-auth](https://github.com/s-KaiNet/node-sp-auth) 



## Prerequisites
 - Node.JS >= 6.x


## Installation

```bash
npm install electron -g # electron needed for an interactive web login
npm install sphooks -g
```

## Usage

#### Loign:
```
sphooks login
```
Runs interactive web login session and allows you to authenticate against SharePoint. Authentication stored in a file in an encrypted manner. If you want to change the site, run `sphooks login` once again. 


#### View:

```
sphooks view --list <list id or url> [--id] <subscription id>
```
 - `--list` - required, GUID or list server relative url, i.e. "sites/dev/My List"
 - `--id` - optional GUID, subscription id. When omitted, all subscriptions will be returned

 Sample:   
 ```
 sphooks view --list "sites/dev/Shared Documents" --id ce38389e-a91d-4df4-b924-0b1956b4640e
```

#### Add: 
```
sphooks add --list <list id or url> --url <notification url> [--exp] <expiration date>
```
 - `--list` - required, GUID or list server relative url, i.e. "sites/dev/My List"
 - `--url` - required string, notification url
 - `--exp` - optional date as ISO formatted string, i.e. '2017-08-16T16:40:09.189Z'. When omitted, date.now + 6 months will be used (maximum allowed for SharePoint web hook)

 Sample:  
 ```
 sphooks add --list 38e3ec1c-1bad-42fa-a60a-2a6c1e49cfba --url https://myfunc.azurewebsites.com/api/webhooks/ --exp 2017-08-16T16:40:09.189Z
 ```


#### Update:
```
sphooks update --list <list id or url> --id <subscription id> [--exp] <expiration date>
```

 - `--list` - required, GUID or list server relative url, i.e. "sites/dev/My List"
  - `--id` - required GUID, subscription id
 - `--exp` - optional date as ISO formatted string, i.e. '2017-08-16T16:40:09.189Z'. When omitted, date.now + 6 months will be used (maximum allowed for SharePoint web hook)

 Sample:  
 ```
 sphooks update --list "sites/dev/Shared Documents" --url https://myfunc.azurewebsites.com/api/webhooks/ --id 183cdbd9-446d-4ff3-a9d4-f01925f55022 --exp 2017-08-16T16:40:09.189Z
```

#### Delete:
```
sphooks delete --list <list id or url> --id <subscription id>
```

 - `--list` - required, GUID or list server relative url, i.e. "sites/dev/My List"
 - `--id` - required GUID, subscription id

Sample 
```
sphooks delete --list "sites/dev/Shared Documents" --id 183cdbd9-446d-4ff3-a9d4-f01925f55022
```

 #### Delete all:
 ```
 sphooks deleteAll --list <list id or url>
 ```
  - `--list` - required, GUID or list server relative url, i.e. "sites/dev/My List"

Sample 
```
sphooks deleteAll --list "sites/dev/Shared Documents" 
```
## Showcase
![sphooks](sphooks.gif)

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