Skip to content

SendOutboundWebNotificationRequest

Source code in docs_src/capo_connect/types/send_outbound_web_notification_request.py
class SendOutboundWebNotificationRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    browser_id: "capo_connect.types.web_browser_id.WebBrowserId"
    """<p>A unique identifier for the customer's web browser instance to which the notification is being sent.</p>"""
    session_id: "capo_connect.types.web_session_id.WebSessionId"
    """<p>A unique identifier for the customer's web session to which the notification is being sent.</p>"""
    expires_at: "capo_connect.types.timestamp.Timestamp"
    """<p>The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.</p>"""
    source: "capo_connect.types.web_notification_source.WebNotificationSource"
    """<p>The source of the web notification. A <code>SourceCampaign</code> object identifies the campaign and outbound request that triggered this notification.</p>"""
    destination: "capo_connect.types.widget_destination.WidgetDestination"
    """<p>The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.</p>"""
    content: "capo_connect.types.web_notification_content.WebNotificationContent"
    """<p>The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.</p>"""

browser_id instance-attribute

browser_id: WebBrowserId

A unique identifier for the customer's web browser instance to which the notification is being sent.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

content instance-attribute

The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

destination instance-attribute

destination: WidgetDestination

The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

expires_at instance-attribute

expires_at: Timestamp

The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

session_id instance-attribute

session_id: WebSessionId

A unique identifier for the customer's web session to which the notification is being sent.

source instance-attribute

The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.