Subscriptions

class O365.subscriptions.Subscriptions(*, parent=None, con=None, **kwargs)

Bases: ApiComponent

Subscription operations for Microsoft Graph webhooks.

__init__(*, parent=None, con=None, **kwargs)

Object initialization

Parameters:

• protocol (Protocol) – A protocol class or instance to be used with this connection

• main_resource (str) – main_resource to be used in these API communications

create_subscription(notification_url: str, resource: str | None = None, change_type: str | Iterable[str] = 'created', *, expiration_datetime: datetime | None = None, expiration_minutes: int | None = None, client_state: str | None = None, include_resource_data: bool | None = None, encryption_certificate: str | None = None, encryption_certificate_id: str | None = None, lifecycle_notification_url: str | None = None, latest_supported_tls_version: str | None = None, additional_data: Mapping[str, object] | None = None, **request_kwargs) → dict | None

Create a Microsoft Graph webhook subscription.

See subscriptions usage documentation for webhook setup requirements.

delete_subscription(subscription_id: str, **request_kwargs) → bool

Delete an existing webhook subscription.

get_subscription(subscription_id: str, *, params: Mapping[str, object] | None = None, **request_kwargs) → dict | None

Retrieve a single webhook subscription by id.

list_subscriptions(*, limit: int | None = None, **request_kwargs) → Iterable[dict] | Pagination

List webhook subscriptions visible to the current app/context.

renew_subscription(subscription_id: str, *, expiration_datetime: datetime | None = None, expiration_minutes: int | None = None, **request_kwargs) → dict | None

Renew an existing webhook subscription.

update_subscription(subscription_id: str, *, notification_url: str | None = None, expiration_datetime: datetime | None = None, expiration_minutes: int | None = None, **request_kwargs) → dict | None

Update subscription fields (expiration and/or notification URL).