Skip to content

CreateNotificationSubscriptionRequest

Source code in docs_src/capo_workdocs/types/create_notification_subscription_request.py 
16
17
18
19
20
21
22
23
24
class CreateNotificationSubscriptionRequest(TypedDict, closed=True):
    organization_id: "capo_workdocs.types.id_type.IdType"
    """<p>The ID of the organization.</p>"""
    endpoint: "capo_workdocs.types.subscription_end_point_type.SubscriptionEndPointType"
    """<p>The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with <code>https</code>.</p>"""
    protocol: "capo_workdocs.types.subscription_protocol_type.SubscriptionProtocolType"
    """<p>The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.</p>"""
    subscription_type: "capo_workdocs.types.subscription_type.SubscriptionType"
    """<p>The notification type.</p>"""

endpoint instance-attribute 

endpoint: SubscriptionEndPointType

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

organization_id instance-attribute 

organization_id: IdType

The ID of the organization.

protocol instance-attribute 

protocol: SubscriptionProtocolType

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

subscription_type instance-attribute 

subscription_type: SubscriptionType

The notification type.