Skip to content

webhooks

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

webhooks

README.md

SharePoint Webhook Subscriptions

Webhooks let your app receive HTTP callbacks when items change in a SharePoint list. Subscriptions are scoped to a single list and expire after 180 days.

Prerequisites

Requirement Description Reference
Site Owner role on the target list Required to add, update, and remove webhook subscriptions. SharePoint admin roles
Public HTTPS endpoint A publicly accessible URL that receives the POST notifications. Webhook notification format

How webhooks work

sequenceDiagram
    participant App as Your App
    participant SP as SharePoint List
    participant Webhook as Your Webhook Endpoint

    App->>SP: 1. Create subscription
    SP-->>App: Subscription ID + expiry

    Note over SP,Webhook: When list items change...

    SP->>Webhook: 2. POST change notification
    Webhook-->>SP: 200 OK (verify token)
    Webhook->>SP: 3. GET change logs
    SP-->>Webhook: Changed item details

    App->>SP: 4. Renew before 180 days
    App->>SP: 5. Delete subscription (cleanup)
Loading

Examples

Step Operation File Required role API reference
1 Add — subscribe to list change notifications add_subscription.py Site Owner on list Create subscription
2 List — enumerate subscriptions on a list get_subscriptions.py Read access List subscriptions
3 Renew — extend expiration date set_expiration.py Site Owner on list Update subscription
4 Remove — unsubscribe from notifications remove_subscription.py Site Owner on list Delete subscription

Quick start

from office365.sharepoint.client_context import ClientContext

ctx = ClientContext("https://contoso.sharepoint.com/sites/team").with_client_secret(
    "contoso.onmicrosoft.com", "client_id", "client_secret"
)

target_list = ctx.web.lists.get_by_title("Documents")

# Subscribe
sub = target_list.subscriptions.add(
    "https://your-app.azurewebsites.net/webhook/notifications"
).execute_query()
print(f"Subscribed: {sub.id} (expires: {sub.expiration_datetime})")

API reference