Event

class contacthub.models.event.Event(node, **attributes)

Bases: object

Event entity definition

class CONTEXTS

` Event subclass for context field of Event. Choose one of the above API validated contexts or add your own in case of new types.

CONTACT_CENTER = 'CONTACT_CENTER'

DIGITAL_CAMPAIGN = 'DIGITAL_CAMPAIGN'

ECOMMERCE = 'ECOMMERCE'

IOT = 'IOT'

MOBILE = 'MOBILE'

OTHER = 'OTHER'

RETAIL = 'RETAIL'

SOCIAL = 'SOCIAL'

WEB = 'WEB'

class MODES

ACTIVE = 'ACTIVE'

PASSIVE = 'PASSIVE'

class TYPES

Event subclass for type field of Event. Choose one of the above API validated types or add your own in case of new types.

ABANDONED_CART = 'abandonedCart'

ABANDONED_SESSION = 'abandonedSession'

ADDED_COMPARE = 'addedCompare'

ADDED_PRODUCT = 'addedProduct'

ADDED_WISH_LIST = 'addedWishList'

CAMPAIGN_BLACKLISTED = 'campaignBlacklisted'

CAMPAIGN_BOUNCED = 'campaignBounced'

CAMPAIGN_LINK_CLICKED = 'campaignLinkClicked'

CAMPAIGN_MARKED_SPAM = 'campaignMarkedSpam'

CAMPAIGN_OPENED = 'campaignOpened'

CAMPAIGN_SENT = 'campaignSent'

CAMPAIGN_SUBSCRIBED = 'campaignSubscribed'

CAMPAIGN_UNSUBSCRIBED = 'campaignUnsubscribed'

CHANGED_SETTING = 'changedSetting'

CLICKED_LINK = 'clickedLink'

CLOSED_TICKET = 'closedTicket'

COMPLETED_ORDER = 'completedOrder'

EVENT_INVITED = 'eventInvited'

EVENT_PARTECIPATED = 'eventParticipated'

FORM_COMPILED = 'formCompiled'

GENERIC_ACTIVE_EVENT = 'genericActiveEvent'

GENERIC_PASSIVE_EVENT = 'genericPassiveEvent'

LOGGED_IN = 'loggedIn'

LOGGED_OUT = 'loggedOut'

OPENED_TICKET = 'openedTicket'

ORDER_SHIPPED = 'orderShipped'

REMOVED_COMPARE = 'removedCompare'

REMOVED_PRODUCT = 'removedProduct'

REMOVED_WISHLIST = 'removedWishList'

REPLIED_TICKET = 'repliedTicket'

REVIEWED_PRODUCT = 'reviewedProduct'

SEARCHED = 'searched'

SERVICE_SUBSCRIBED = 'serviceSubscribed'

SERVICE_UNSUBSCRIBED = 'serviceUnsubscribed'

VIEWED_PAGE = 'viewedPage'

VIEWED_PRODUCT = 'viewedProduct'

VIEWED_PRODUCT_CATEGORY = 'viewedProductCategory'

classmethod from_dict(node, attributes=None)

Create a new Properties initialized by a specified dictionary of attributes

Parameters:

• node – the node of the customer supposed to be associated with this event
• attributes – key-value arguments for generating the structure of the Education’s attributes

Returns:

a new Properties object

post()

Post this Event in the associated Node. For posting it and associate with a known customer, specify the customer id in the attributes of the Event. For associate it to an external Id or a session id of a customer, specify in the bringBackProperties object like: {‘type’:’EXTERNAL_ID’, ‘value’:’value’, ‘nodeId’:’nodeId’ }

to_dict()

Convert this Event in a dictionary containing his attributes.

Returns:a new dictionary representing the attributes of this Event