Skip to content

SubscriptionEventItem

Source code in docs_src/capo_customer_profiles/types/subscription_event_item.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class SubscriptionEventItem(TypedDict, closed=True):
    profile_id: NotRequired["capo_customer_profiles.types.uuid.uuid"]
    """<p>The unique identifier of a customer profile.</p>"""
    updated_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the membership change was detected. </p>"""
    event_type: NotRequired[
        "capo_customer_profiles.types.subscription_event_type.SubscriptionEventType"
    ]
    """<p>The type of event that triggered the membership change. The following are valid values: </p> <ul> <li> <p> <b>LIVE</b>: Real-time event triggered by a profile or calculated attribute change (Classic segments only). </p> </li> <li> <p> <b>SCHEDULE</b>: Event generated during a scheduled execution. </p> </li> </ul>"""
    event: NotRequired[
        "capo_customer_profiles.types.subscription_event.SubscriptionEvent"
    ]
    """<p>Whether the profile joined or left the segment. The following are valid values: </p> <ul> <li> <p> <b>JOINED</b>: The profile joined the segment. </p> </li> <li> <p> <b>LEFT</b>: The profile left the segment. </p> </li> </ul>"""

event instance-attribute 

event: NotRequired[SubscriptionEvent]

Whether the profile joined or left the segment. The following are valid values:

  • JOINED: The profile joined the segment.

  • LEFT: The profile left the segment.

event_type instance-attribute 

event_type: NotRequired[SubscriptionEventType]

The type of event that triggered the membership change. The following are valid values:

  • LIVE: Real-time event triggered by a profile or calculated attribute change (Classic segments only).

  • SCHEDULE: Event generated during a scheduled execution.

profile_id instance-attribute 

profile_id: NotRequired[uuid]

The unique identifier of a customer profile.

updated_at instance-attribute 

updated_at: NotRequired[timestamp]

The timestamp of when the membership change was detected.