external help file | applicable | schema |
---|---|---|
SharePoint Online |
2.0.0 |
Adds a new Webhook subscription
Add-PnPWebhookSubscription -NotificationUrl <String>
[-List <ListPipeBind>]
[-ExpirationDate <DateTime>]
[-ClientState <String>]
[-Web <WebPipeBind>]
[-Connection <SPOnlineConnection>]
PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook
Add a Webhook subscription for the specified notification Url on the list MyList
PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01"
Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017
PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -ClientState "Hello State!"
Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 with a specific client state
A client state information that will be passed through notifications
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
The date at which the Webhook subscription will expire. (Default: 6 months from today)
Type: DateTime
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
The list object or name where the Webhook subscription will be added to
Type: ListPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
The URL of the Webhook endpoint that will be notified of the change
Type: String
Parameter Sets: (All)
Required: True
Position: Named
Accept pipeline input: False
Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: SPOnlineConnection
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
Type: WebPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False