SP REST Create Alert API (/_api/Web/CurrentUser/Alerts/Add)

[salascz]

What type of issue is this?

Question

What SharePoint development model, framework, SDK or API is this about?

SharePoint REST API

Target SharePoint environment

SharePoint Online

What browser(s) / client(s) have you tested

• 💥 Internet Explorer
• 💥 Microsoft Edge
• 💥 Google Chrome
• 💥 FireFox
• 💥 Safari
• mobile (iOS/iPadOS)
• mobile (Android)
• not applicable
• other (enter in the "Additional environment details" area below)

Additional environment details

No response

Issue description

I am exploring the Alerts REST API (/web/alerts, /web/currentuser/alerts etc.).

I would like to ask, if there is any documentation available for /Alerts/Add endpoint.

It does not seem to be working on my end (other endpoints like list of all alerts, alert details or delete alert works correctly)

POST [site]/_api/Web/CurrentUser/Alerts/Add
BODY

{
    "alertCreationInformation": {
        "AlertFrequency": 1,
        "AlertTemplateName": "SPAlertTemplateType.WebPageLibrary",
        "AlertTime": "2021-07-29T11:56:18.9574215+02:00",
        "AlertType": 0,
        "AlwaysNotify": false,
        "DeliveryChannels":1,
        "EventType": -1,
        "EventTypeBitmask"  : 2,
        "Filter": "",
        "Status": 0,
        "Title": "Alert -- generated",
        "Properties": []
    }
}

The AlertCreationInformation type does not contain any property for List, Item or User :(
https://s-kainet.github.io/sp-rest-explorer/#/_api/web/CurrentUser/Alerts/Add

Thanks

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

[psharplessk2c]

Any update on this? I too am trying to create an Alert via the API's and I can't figure out to how to do it successfully. The AlertCreationInformation class does not seem to have the fields necessary to tie the new alert to a user or a list.

[richpyra]

I'd love to be able to create an Alert via the SharePoint framework. At the moment it appears to be impossible

[alfredogama]

I'm trying to create a new alert but is not possible. Where is the documentation?

[github-actions]

Thank you for taking the time to file an issue. We periodically archive older or inactive issues as part of our issue management process, which automatically closes them once they are archived.

If you’d like to understand more about why and how we handle archived (closed) issues, please see Our approach to closed issues.

We appreciate your contribution and if this is still an active issue with the latest SPFx versions, please do resubmit the details. We needed to perform a cleanup, so that we can start with a clean table with a new process. We apologize for the inconvenience this might cause.

[matherm-aboehm]

I'm also trying to create a new alert with this API, but I can't find a way to specify the list item and user for the new alert.

In the past I used the CSOM API (/_vti_bin/client.svc/ProcessQuery) where it was possible to specify all the required object references by using ObjectPath bindings. But now, Microsoft found a way to disable this special CSOM operation for alert creation by introducing a new "bug".
The error message I get translates to something like: 'Item' and 'item.ParentList' must not both be null.
I already tested if all objects for all ObjectPaths are null or not, by using individual CSOM APIs on these objects and all tests were succeeding, which shows me that these objects are in fact not null. Only the CSOM API for alert creation complains.

So, together with missing pieces on the REST API, there seems to be no way at all to create new alerts with any API.