Skip to content

Commit c2151d9

Browse files
suramamsuramam
authored andcommitted
Merge branch 'staging' of https://github.com/SharePoint/sp-dev-docs into staging
2 parents 97f3a0f + fd887b7 commit c2151d9

20 files changed

+790
-758
lines changed

docs/apis/webhooks/get-started-webhooks.md

Lines changed: 472 additions & 0 deletions
Large diffs are not rendered by default.

docs/apis/webhooks/lists/create-subscription.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
# Create a new subscription
2-
Creates a new subscription. In the POST request, include properties to describe the subscription you want created.
2+
3+
>**Note:** SharePoint webhooks is currently in preview and is subject to change. SharePoint webhooks are not currently supported for use in production environments.
4+
5+
Creates a new webhook subscription on a SharePoint list.
36

47
## Permissions
58

69
The application must have at least edit permissions to the SharePoint list where the subscription will be created.
710

8-
**If your application is an Azure Active Directory (AAD) application:**
11+
**If your application is a Microsoft Azure Active Directory (AD) application:**
912

10-
You must grant the AAD app permissions to the folowing SharePoint application and the corresponding permissions:
13+
You must grant the Azure AD app the permissions specified in the following table:
1114

1215
Application | Permission
1316
------------|------------
14-
Office 365 SharePoint Online|read and write items and lists in all site collections.
17+
Office 365 SharePoint Online|Read and write items and lists in all site collections.
1518

1619
**If your application is a SharePoint add-in:**
1720

18-
You must grant the add-in at least the following permission(s) or higher:
21+
You must grant the SharePoint add-in the following permission(s) or higher:
1922

2023
Scope | Permission Rights
2124
------|------------
@@ -28,14 +31,15 @@ POST /_api/web/lists('list-id')/subscriptions
2831
```
2932

3033
## Request body
34+
3135
Include the following properties in the request body.
3236

3337
Name | Type | Description
3438
-----|------|------------
3539
resource|string|The URL of the list to receive notifications from.
3640
notificationUrl|string|The service URL to send notifications to.
3741
expirationDateTime|date|The date the notification will expire and be deleted.
38-
client-clientState|string|Optional. Opaque string passed back to the client on all notifications. You can use this for validating notificaitons, or tagging different subscriptions.
42+
client-clientState|string|Optional. Opaque string passed back to the client on all notifications. You can use this for validating notifications, or tagging different subscriptions.
3943

4044

4145
### Example
@@ -53,6 +57,7 @@ Content-Type: application/json
5357
```
5458

5559
## Response
60+
5661
If the subscription is added, then a `201 Created` response is returned that
5762
includes the newly created subscription object.
5863

@@ -71,6 +76,7 @@ Content-Type: application/json
7176
```
7277

7378
## URL validation
79+
7480
Before a new subscription is created, SharePoint will send a request with a validation token in the body of the request to the service URL provided. Your service must respond to this request by returning the validation token.
7581

76-
If your service fails to validate the request in this way, the subscription will not be created. See [SharePoint list webhooks](../overview-sharepoint-webhooks.md) for more information.
82+
If your service fails to validate the request in this way, the subscription will not be created. See [Overview of SharePoint webhooks](../overview-sharepoint-webhooks) for more information.

docs/apis/webhooks/lists/delete-subscription.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
11
# Delete a subscription
22

3+
>**Note:** SharePoint webhooks is currently in preview and is subject to change. SharePoint webhooks are not currently supported for use in production environments.
4+
35
Deletes a webhook subscription from a SharePoint list. After deleting the subscription notifications will no longer be delivered.
46

57
## Permissions
68

7-
* A subscription can only be deleted by the application that created it.
8-
* To delete a subscription the application must have **read-write permissions** to the SharePoint list the subscription exists on.
9+
The application must have at least edit permissions to the SharePoint list where the subscription will be deleted.
10+
11+
**If your application is a Microsoft Azure Active Directory (AD) application:**
12+
13+
You must grant the Azure AD app the permissions specified in the following table. A subscription can only be deleted by the Azure AD application that created it.
14+
15+
Application | Permission
16+
------------|------------
17+
Office 365 SharePoint Online|Read and write items and lists in all site collections.
18+
19+
**If your application is a SharePoint add-in:**
20+
21+
You must grant the SharePoint add-in the following permission(s) or higher. A subscription can only be deleted by the SharePoint add-in that created it.
22+
23+
Scope | Permission Rights
24+
------|------------
25+
List|Manage
926

1027
## HTTP request
1128

@@ -20,6 +37,7 @@ DELETE _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('6D7
2037
```
2138

2239
## Request body
40+
2341
Do not supply a request body for this method.
2442

2543
## Response
@@ -30,4 +48,4 @@ If the subscription is found and successfully deleted, then a `204 No Content` r
3048

3149
```http
3250
HTTP/1.1 204 No Content
33-
```
51+
```

docs/apis/webhooks/lists/get-subscription.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,50 @@
11
# Get subscriptions
22

3+
>**Note:** SharePoint webhooks is currently in preview and is subject to change. SharePoint webhooks are not currently supported for use in production environments.
4+
35
Gets one or more webhook subscriptions on a SharePoint list.
46

57
## Permissions
68

79
### Get a single subscription
810

9-
* A subscription can only be retrieved by the application that created it.
10-
* To get subscriptions, your application must have the **read-write permissions** to the SharePoint list where the subscriptions exist.
11+
The application must have at least edit permissions to the SharePoint list where the subscription will be retreived.
12+
13+
**If your application is a Microsoft Azure Active Directory (AD) application:**
14+
15+
You must grant the Azure AD application the permissions specified in the following table. A subscription can only be retrieved by the Azure AD application that created it.
16+
17+
Application | Permission
18+
------------|------------
19+
Office 365 SharePoint Online|Read and write items and lists in all site collections.
20+
21+
**If your application is a SharePoint add-in:**
22+
23+
You must grant the SharePoint add-in the following permission(s) or higher. A subscription can only be retrieved by the SharePoint add-in that created it.
24+
25+
Scope | Permission Rights
26+
------|------------
27+
List|Manage
1128

1229
### Get all subscriptions
1330

14-
* To get all subscriptions on a SharePoint list, your application must have the **manage lists permissions** on the SharePoint list where the subscriptions exist.
31+
The application must have manage list permissions to the SharePoint list where the subscription will be retrieved.
32+
33+
**If your application is a Microsoft Azure Active Directory (AD) application:**
34+
35+
You must grant the Azure AD app the permissions specified in the following table.
36+
37+
Application | Permission
38+
------------|------------
39+
Office 365 SharePoint Online|Have full control of all site collections.
40+
41+
**If your application is a SharePoint add-in:**
42+
43+
You must grant the SharePoint add-in the following permission(s) or higher.
44+
45+
Scope | Permission Rights
46+
------|------------
47+
List|Full control
1548

1649
## HTTP request
1750

@@ -29,9 +62,11 @@ GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('6D7703
2962
```
3063

3164
#### Request body
65+
3266
Do not supply a request body for this method.
3367

3468
##### Response
69+
3570
This returns the subscription viewable by the calling application.
3671

3772
```http
@@ -64,6 +99,7 @@ GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions
6499
```
65100

66101
#### Request body
102+
67103
Do not supply a request body for this method.
68104

69105
##### Response
Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
# SharePoint list webhooks
22

3+
>**Note:** SharePoint webhooks is currently in preview and is subject to change. SharePoint webhooks are not currently supported for use in production environments.
4+
35
The SharePoint list webhooks cover the events corresponding to list item changes for a given SharePoint list or a document library. SharePoint webhooks provide a simple notification pipeline so your application can be aware of changes to a SharePoint list without polling the service.
46

5-
## Common tasks
7+
## Tasks
68
| Task | HTTP method |
79
|-----------------------------------------------------|--------------------------------------------------------------|
810
| [Create a new subscription](./create-subscription) | `POST /_api/web/lists('list-guid')/subscriptions` |
9-
| [Get subscription(s)](./get-subscription) | `GET /_api/web/lists('list-guid')/subscriptions` |
10-
| [Delete subscription](./delete-subscription) | `DELETE /_api/web/lists('list-guid')/subscriptions('id')` |
11+
| [Get subscriptions](./get-subscription) | `GET /_api/web/lists('list-guid')/subscriptions` |
12+
| [Delete a subscription](./delete-subscription) | `DELETE /_api/web/lists('list-guid')/subscriptions('id')` |
1113
| [Update a subscription](./update-subscription) | `PATCH /_api/web/lists('list-guid')/subscriptions('id')` |
1214

1315
## List event types
14-
Notifications will be sent to your application for the following **asynchronous list item events** in SharePoint:
15-
16-
1. ItemAdded
17-
2. ItemUpdated
18-
3. ItemDeleted
19-
4. ItemCheckedOut
20-
5. ItemCheckedIn
21-
6. ItemUncheckedOut
22-
7. ItemAttachmentAdded
23-
8. ItemAtttachmentDeleted
24-
9. ItemFileMoved
25-
10. ItemVersonDeleted
26-
11. ItemFileConverted
16+
Notifications will be sent to your application for the following asynchronous list item events in SharePoint:
17+
18+
* ItemAdded
19+
* ItemUpdated
20+
* ItemDeleted
21+
* ItemCheckedOut
22+
* ItemCheckedIn
23+
* ItemUncheckedOut
24+
* ItemAttachmentAdded
25+
* ItemAtttachmentDeleted
26+
* ItemFileMoved
27+
* ItemVersonDeleted
28+
* ItemFileConverted
2729

2830
Synchronous events are not supported in webhooks.
2931

3032
## Additional resources
3133

32-
- [Overview of SharePoint webhooks](../sharepoint-webhooks-overview)
34+
* [Overview of SharePoint webhooks](../overview-sharepoint-webhooks)

docs/apis/webhooks/lists/update-subscription.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# Update a subscription
22

3+
>**Note:** SharePoint webhooks is currently in preview and is subject to change. SharePoint webhooks are not currently supported for use in production environments.
4+
35
Updates a webhook subscription on a SharePoint list.
46

57
## Permissions
68

7-
The application must have at least edit permissions to the SharePoint list where the subscription will be created.
9+
The application must have at least edit permissions to the SharePoint list where the subscription will be updated.
810

9-
**If your application is an Azure Active Directory (AAD) application:**
11+
**If your application is an Microsoft Azure Active Directory (AD) application:**
1012

11-
You must grant the AAD app permissions to the folowing SharePoint application and the corresponding permissions. A subscription can only be updated by the AAD application that created it.
13+
You must grant the Azure AD application the permissions specified in the following table. A subscription can only be updated by the Azure AD application that created it.
1214

1315
Application | Permission
1416
------------|------------
15-
Office 365 SharePoint Online|read and write items and lists in all site collections.
17+
Office 365 SharePoint Online|Read and write items and lists in all site collections.
1618

1719
**If your application is a SharePoint add-in:**
1820

19-
You must grant the add-in at least the following permission(s) or higher. A subscription can only be updated by the add-in that created it.
21+
You must grant the SharePoint add-in the following permission(s) or higher. A subscription can only be updated by the SharePoint add-in that created it.
2022

2123
Scope | Permission Rights
2224
------|------------
@@ -41,13 +43,14 @@ Content-Type: application/json
4143
```
4244

4345
## Request body
46+
4447
Include the following properties in the request body.
4548

4649
Name | Type | Description
4750
-----|------|------------
4851
notificationUrl|string|The service URL to send notifications to.
4952
expirationDateTime|date|The date the notification will expire and be deleted.
50-
client-clientState|string|Optional. Opaque string passed back to the client on all notifications. You can use this for validating notificaitons, or tagging different subscriptions.
53+
client-clientState|string|Optional. Opaque string passed back to the client on all notifications. You can use this for validating notifications, or tagging different subscriptions.
5154

5255

5356
## Response

docs/apis/webhooks/lists/webhook-notification.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)