Obtention d’abonnements

Obtient un ou plusieurs abonnements de webhook sur une liste SharePoint.

Autorisations

Les tableaux d’autorisations de complément SharePoint ci-dessous sont des références héritées uniquement. Utiliser l’authentification Microsoft Entra prise en charge pour les webhooks SharePoint Online.

Importante

Les compléments SharePoint ont atteint leur fin de vie dans SharePoint Online le 2 avril 2026. Les compléments hébergés par SharePoint et par le fournisseur sont mis hors service et ne fonctionnent plus dans SharePoint Online, y compris les clouds publics. Les instructions de développement, de déploiement et d’utilisation des compléments sont conservées à titre de référence historique et pour les scénarios SharePoint Server applicables, et non pour les nouvelles solutions SharePoint Online.

Les compléments SharePoint Server déployés via un catalogue d’applications local ne sont pas mis hors service par cette modification. L’acquisition de compléments SharePoint sur la place de marché publique a pris fin le 2 avril 2026 pour SharePoint Server.

Ce retrait ne met pas hors service les API REST SHAREPoint, CSOM, JSOM ou SharePoint Framework (SPFx). Pour SharePoint Online, utilisez SPFx pour les extensions d’interface utilisateur et Microsoft Entra ID pour l’authentification auprès des applications externes. Consultez l’annonce de mise hors service et les conseils sur la migration des compléments.

Obtenir un seul abonnement

L’application doit au moins disposer d’autorisations de modification sur la liste SharePoint où l’abonnement sera récupéré.

Si votre application est une application Microsoft Azure Active Directory (Azure AD) :

Vous devez accorder à l’application Azure AD les autorisations définies dans le tableau suivant. Un abonnement peut uniquement être récupéré par l’application Azure Active Directory qui l’a créé.

Application Autorisation
Office 365 SharePoint Online Lire et écrire des éléments et des listes dans toutes les collections de sites.

Si votre application est un complément SharePoint :

Vous devez accorder au complément SharePoint les autorisations suivantes ou des autorisations supérieures : Un abonnement peut uniquement être récupéré par le complément SharePoint qui l’a créé.

Domaine d’application Droits d’autorisation
Répertorier Gérer

Obtention de tous les abonnements

L’application doit disposer d’autorisations de gestion de liste pour la liste SharePoint dans laquelle l’abonnement sera récupéré.

Si votre application est une application Azure AD

Vous devez accorder à l’application Azure AD les autorisations définies dans le tableau suivant.

Application Autorisation
Office 365 SharePoint Online Contrôle total de toutes les collections de sites.

Si votre application est un complément SharePoint :

Vous devez accorder au complément SharePoint les autorisations suivantes ou des autorisations supérieures :

Domaine d’application Droits d’autorisation
Répertorier Contrôle total

Requête HTTP

Obtenir un seul abonnement

Webhook de liste

GET _api/web/lists('list-id')/subscriptions('id')
Exemple
GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('6D77031A-2345-5GRT-BV3D-55234B56FR43')

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Renvoie l’abonnement de manière visible par l’application appelante.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "odata.metadata": "https://contoso.sharepoint.com/_api/$metadata#SP.ApiData.Subscriptions/@Element",
  "odata.type": "Microsoft.SharePoint.Webhooks.Subscription",
  "odata.id": "https://contoso.sharepoint.com/_api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7')",
  "odata.editLink": "web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7')",
  "expirationDateTime": "2016-04-30T16:17:57Z",
  "id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
  "notificationUrl": "https://contoso.azurewebistes.net/api/webhook/handlerequest",
  "resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
}

Obtention de tous les abonnements

Webhook de liste

GET _api/web/lists('list-id')/subscriptions
Exemple
GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Renvoie une collection de tous les abonnements sur une ressource SharePoint.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "odata.metadata": "https://a830edad9050849295j16032914.sharepoint.com/_api/$metadata#SP.ApiData.Subscriptions",
  "value": [
    {
      "odata.type": "Microsoft.SharePoint.Webhooks.Subscription",
      "odata.id": "https://contoso.sharepoint.com/_api/Microsoft.SharePoint.Webhooks.Subscriptionc3175b9c-1491-454f-b5da-980431e36146",
      "odata.editLink": "Microsoft.SharePoint.Webhooks.Subscriptionc3175b9c-1491-454f-b5da-980431e36146",
      "clientState": "{A0A354EC-97D4-4D83-9DDB-144077ADB449}",
      "expirationDateTime": "2016-04-30T16:17:57Z",
      "id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
      "notificationUrl": "https://contoso.azurewebsites.net/api/webhook/handlerequest",
      "resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
    }
  ]
}

Voir aussi