Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s-kainet/sphooks
Cross-platform CLI for managing SharePoint list web hooks
https://github.com/s-kainet/sphooks
nodejs sharepoint-online typescript webhooks
Last synced: about 10 hours ago
JSON representation
Cross-platform CLI for managing SharePoint list web hooks
- Host: GitHub
- URL: https://github.com/s-kainet/sphooks
- Owner: s-KaiNet
- Created: 2017-08-16T18:23:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-01T18:39:33.000Z (about 7 years ago)
- Last Synced: 2024-11-14T05:00:40.358Z (4 days ago)
- Topics: nodejs, sharepoint-online, typescript, webhooks
- Language: JavaScript
- Size: 2.96 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sphooks - cross-platform CLI for managing SharePoint list web hooks
[](https://nodei.co/npm/sphooks/)
[](https://badge.fury.io/js/sphooks)
### Need help on SharePoint with Node.JS? Join our gitter chat and ask question! [](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 [--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 --url [--exp]
```
- `--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 --id [--exp]
```
- `--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 --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` - required, GUID or list server relative url, i.e. "sites/dev/My List"
Sample
```
sphooks deleteAll --list "sites/dev/Shared Documents"
```
## Showcase
