Introduction:
StudentAdvisor has the ability to trigger and send event notifications in the form of JSON data which is sent to an institution's defined endpoint URL. Similar to events triggered by other CampusLogic products, institutions can manage which events they wish to subscribe to in PlatformManagement and CL Connect.
StudentAdvisor Events:
StudentAdvisor sends events that revolve around conversations held in VirtualAdvisor with authenticated students. Please note that this does not include any conversation where the user is anonymous because there is no identifier to track whether it is a student or outside user. The information below lists each event, how it is triggered, and the data that comes in the initial message and API callback message.
801 - Authenticated Conversation Started
- This event is triggered when an authenticated student has started a conversation. This includes starting a conversation while logged into StudentForms or ScholarshipUniverse, or authenticates during the conversation - whether initiated by themselves, requested authentication from an advisor, or requested authentication by VirtualAdvisor to provide specific student data.
- The initial event notification contains the following data:
{
ClientId: Internal CampusLogic Client ID,
UserId: Internal CampusLogic User ID,
StudentId: Institution's Student ID,
ClConversationId: Internal CampusLogic Conversation ID,
ConversationSource: Source of Conversation (i.e. web chat, SMS, etc),
ConversationProductContext: StudentAdvisor,
Id: Internal CampusLogic Event ID,
ProductId: Internal CampusLogic Product ID,
Product: CampusLogic Product Name If Student Starts Conversation in Product, Otherwise This Will Be Null/Blank,
Client: Client Name,
EventNotificationId: 801,
EventNotificationName: Authenticated Conversation Started,
DateTimeUtc: YYYY-MM-DDTHH:MM:SS.SSSZ
}
- This event DOES NOT trigger am API callback for the getConversation JSON. This is only used for tracking the beginning of a conversation.
802 - Authenticated Conversation Ended
- This event is triggered when a conversation had ended with an authenticated student. Either the student 1) manually leaves a conversation by clicking the X icon in the chat window and confirms leaving the conversation, or 2) student's last response has met the last response duration limit set with the Basic Settings page and VirtualAdvisor has considered the conversation ended.
- The initial event notification contains the following data:
{
ClientId: Internal CampusLogic Client ID,
UserId: Internal CampusLogic User ID,
StudentId: Institution's Student ID,
ClConversationId: Internal CampusLogic Conversation ID,
ConversationSource: Source of Conversation (i.e. web chat, SMS, etc),
ConversationProductContext: StudentAdvisor,
Id: Internal CampusLogic Event ID,
ProductId: Internal CampusLogic Product ID,
Product: CampusLogic Product Name If Student Starts Conversation in Product, Otherwise This Will Be Null/Blank,
Client: Client Name,
EventNotificationId: 802,
EventNotificationName: Authenticated Conversation Ended,
DateTimeUtc: YYYY-MM-DDTHH:MM:SS.SSSZ
}
- The API callback for the getConversation JSON includes the following data:
{
saMessageCount: Total Count of Messages Between Student and VirtualAdvisor/School Advisors; This Does Not Include Introduction Messages When Student Authenticates And/Or Advisor Joins/Leaves Conversation,
saCategories: List of Each Category Determined In the Conversation, Separated By A Pipe Delimter,
saAdvisors: List of Each Advisor (If Any) Who Joined Conversation, Separated By A Pipe Delimter,
saTranscript: This Includes The Entire Transcript of the Conversation Between the Student and VirtualAdvisor/School Advisors; Each Message Is Separated By A Semi-Colon,
saHasSensitiveData: True/False if any part of the conversation has been marked as sensitive,
}
Related Articles