sp-dev-fx-webparts/samples/react-webhooks-realtime
Hugo Bernier 985384732a Updated legacy compatiblity matrix 2021-11-07 01:33:53 -05:00
..
.vscode New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
assets Changed from updated to modificationDateTime 2021-05-02 15:39:42 -04:00
config New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
src/webparts/realTimeList New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
typings New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
.editorconfig New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
.gitignore New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
.yo-rc.json New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
DeploySPFxToAppCatalog.ps1 New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
DeploySPFxToAppCatalogRequestBody.xml New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
DeploySPFxToO365CDN.ps1 New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
ProvisioningArtifacts.ps1 New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
README.md Updated legacy compatiblity matrix 2021-11-07 01:33:53 -05:00
gulpfile.js New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
package.json New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
tsconfig.json New sample SPFx webhooks real time (#351) 2017-11-06 09:32:25 +02:00
tslint.json Add tslint at the root of each SPFx project (#394) 2018-01-08 15:58:48 +02:00

README.md

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies platforms createdDate
samples
SharePoint Framework
react
11/1/2017 12:00:00 AM

Webhooks Realtime

Summary

This web part demonstrates how to leverage the capabilities of SharePoint Webhooks. The libraries used by this web part are Socket.io, sp pnp js, moment.

Preview

Solution architecture

Architecture

Compatibility

SPFx 1.3.0 Node.js v6 Compatible with SharePoint Online Compatible SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible

Applies to

Prerequisites

In order to use properly this web part is necessary follow these steps:

  • Istall a webserver that will receive the webhooks, for this PoC I created a NodeJs Application hosted on Azure take a look on my solution https://github.com/giuleon/SharePoint-Webhooks-Broadcaster
  • run the Powershell script ProvisioningArtifacts.ps1 in order to provision the list Events which is required for this web part
  • Create a new webhooks subscription for the SharePoint List Events (that will be installed by running the script ProvisioningArtifacts.ps1), as you prefer, across your solution or Postman, please read the following guideline to achieve this goal https://docs.microsoft.com/en-us/sharepoint/dev/apis/webhooks/overview-sharepoint-webhooks
  • The web part has been developed (GetChanges API) to notify new items added in the Events list

Solution

Solution Author(s)
react-webhooks-realtime Giuliano De Luca (@giuleon , www.delucagiuliano.com)

Version history

Version Date Comments
1.0 October 29, 2017 Initial release

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.


Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp serve

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • How to leverage the capabilities of SharePoint webhooks.