Alice API Events

RequestUpdate
- - RequestUpdate event type
    
    This event is sent for Staff api users on ticket created/updated
    
    Model Description
    
    AliceEvent {
    author (string):
    Always the same value "system"
    ,
    
    kind (string):
    Always the same value "status"
    ,
    
    id (string):
    Sequential id or 0
    ,
    
    type (string):
    "RequestUpdate"
    ,
    
    ticket (integer):
    Id of the ticket
    ,
    
    conv (integer):
    Always null for this event type
    ,
    
    text (string):
    Description of the action or empty
    ,
    
    status (string):
    Status of the ticket or null
    ,
    
    ticketRejected (boolean):
    true if ticket was rejected
    ,
    
    hide (boolean):
    for internal use
    ,
    
    facility (number):
    Facility of the ticket
    ,
    
    time (number):
    Event generation time
    ,
    
    owner (number):
    Ticket owner id
    ,
    
    terminalState (boolean):
    true if ticket is done or null
    ,
    
    windowId (string):
    for internal use
    ,
    
    ticketUnreadGuestMessages (number):
    Always null
    ,
    
    ticketType (string):
    Type of the ticket. Conversation, InventoryItem, MenuOrder, OfflineRequest, Reminder, ReservationRequest, ServiceRequest
    ,
    
    ticketStatus (string):
    Ticket status. New, Processing, Transferred, Approved, InProgress, Rejected, Finished, Expired
    ,
    
    hotelId (number):
    Hotel id
    ,
    
    subject (string):
    Always null
    ,
    
    campaignMessageId (number):
    Always null
    ,
    
    reservationId (number):
    Reservation id of the ticket
    ,
    
    ticketReservationId (number):
    Reservation id of the ticket
    }
    Example
    
    { "author": "system", "kind": "status", "id": 0, "type": "RequestUpdate", "ticket": 228217, "conv": null, "text": "", "status": "Processing", "ticketRejected": false, "hide": null, "facility": 24, "time": 1487362609362, "owner": null, "terminalState": null, "windowId": "3f71865c-6e5f-4b1b-bb05-df99651899fc", "ticketUnreadGuestMessages": null, "ticketType": "ServiceRequest", "ticketStatus": "Processing", "hotelId": 6, "subject": null, "campaignMessageId": null, "reservationId": null, "ticketReservationId": 92886 }
GuestRequestCreatedByStaff
- - GuestRequestCreatedByStaff event type
    
    This event is sent to Guest api users on ticket created by staff for guest.
    
    Model Description
    
    AliceEvent {
    author (string):
    Always the same value "system"
    ,
    
    kind (string):
    Always the same value "status"
    ,
    
    id (string):
    Sequential id or 0
    ,
    
    type (string):
    "GuestRequestCreatedByStaff"
    ,
    
    ticket (integer):
    Id of the ticket
    ,
    
    conv (integer):
    Always null for this event type
    ,
    
    text (string):
    Description of the action or empty
    ,
    
    status (string):
    Status of the ticket or null
    ,
    
    ticketRejected (boolean):
    true if ticket was rejected
    ,
    
    hide (boolean):
    for internal use
    ,
    
    facility (number):
    Facility of the ticket
    ,
    
    time (number):
    Event generation time
    ,
    
    owner (number):
    Ticket owner id
    ,
    
    terminalState (boolean):
    true if ticket is done or null
    ,
    
    windowId (string):
    for internal use
    ,
    
    ticketUnreadGuestMessages (number):
    Always null
    ,
    
    ticketType (string):
    Type of the ticket. Conversation, InventoryItem, MenuOrder, OfflineRequest, Reminder, ReservationRequest, ServiceRequest
    ,
    
    ticketStatus (string):
    Ticket status. New, Processing, Transferred, Approved, InProgress, Rejected, Finished, Expired
    ,
    
    hotelId (number):
    Hotel id
    ,
    
    subject (string):
    Always null
    ,
    
    campaignMessageId (number):
    Always null
    ,
    
    reservationId (number):
    Reservation id of the ticket
    ,
    
    ticketReservationId (number):
    Reservation id of the ticket
    }
    Example
    
    { "author": "system", "kind": "status", "id": 118, "type": "GuestRequestCreatedByStaff", "ticket": 228217, "conv": null, "text": "", "status": "Processing", "ticketRejected": false, "hide": null, "facility": 24, "time": 1487362609362, "owner": null, "terminalState": null, "windowId": "3f71865c-6e5f-4b1b-bb05-df99651899fc", "ticketUnreadGuestMessages": null, "ticketType": "ServiceRequest", "ticketStatus": "Processing", "hotelId": 6, "subject": null, "campaignMessageId": null, "reservationId": null, "ticketReservationId": 92886 }
TicketComment
- - TicketComment event type
    
    This event is sent to Guest or Staff api users on new message or internal note added to ticket.
    
    Model Description
    
    AliceEvent {
    author (string):
    Always the same value "system"
    ,
    
    kind (string):
    Always the same value "status"
    ,
    
    id (string):
    Sequential id
    ,
    
    type (string):
    "TicketComment"
    ,
    
    ticket (integer):
    Id of the ticket
    ,
    
    conv (integer):
    Conversation id
    ,
    
    text (string):
    Message text
    ,
    
    status (string):
    Guest or Internal
    ,
    
    ticketRejected (boolean):
    true if ticket was rejected
    ,
    
    hide (boolean):
    for internal use
    ,
    
    facility (number):
    Facility of the ticket
    ,
    
    time (number):
    Event generation time
    ,
    
    owner (number):
    Always null
    ,
    
    terminalState (boolean):
    true if ticket is done or null
    ,
    
    windowId (string):
    for internal use
    ,
    
    ticketUnreadGuestMessages (number):
    Number of guest messages unread by staff
    ,
    
    ticketType (string):
    Type of the ticket. Conversation, InventoryItem, MenuOrder, OfflineRequest, Reminder, ReservationRequest, ServiceRequest
    ,
    
    ticketStatus (string):
    Ticket status. New, Processing, Transferred, Approved, InProgress, Rejected, Finished, Expired
    ,
    
    hotelId (number):
    Hotel id
    ,
    
    subject (string):
    Always null
    ,
    
    campaignMessageId (number):
    Always null
    ,
    
    reservationId (number):
    Reservation id of the ticket
    ,
    
    ticketReservationId (number):
    Reservation id of the ticket
    }
    Example
    
    { "author": "system", "kind": "status", "id": 119, "type": "TicketComment", "ticket": 227145, "conv": 194729, "text": "test", "status": "Internal", "ticketRejected": false, "hide": true, "facility": 24, "time": 1487362609362, "owner": null, "terminalState": false, "windowId": null, "ticketUnreadGuestMessages": 1, "ticketType": "ServiceRequest", "ticketStatus": "Processing", "hotelId": 6, "subject": null, "campaignMessageId": null, "reservationId": null, "ticketReservationId": 92886 }
HotelUpdate
- - HotelUpdate event type
    
    This event is sent to Guest or Staff when hotel info is updated. For example facility has changed or new service created.
    
    Model Description
    
    AliceEvent {
    author (string):
    Always the same value "system"
    ,
    
    kind (string):
    Always the same value "status"
    ,
    
    id (string):
    Always 0
    ,
    
    type (string):
    "HotelUpdate"
    ,
    
    ticket (integer):
    Always null
    ,
    
    conv (integer):
    Always null
    ,
    
    text (string):
    Empty string
    ,
    
    status (string):
    Always null
    ,
    
    ticketRejected (boolean):
    Always false
    ,
    
    hide (boolean):
    for internal use
    ,
    
    facility (number):
    Always null
    ,
    
    time (number):
    Event generation time
    ,
    
    owner (number):
    Always null
    ,
    
    terminalState (boolean):
    Always null
    ,
    
    windowId (string):
    for internal use
    ,
    
    ticketUnreadGuestMessages (number):
    Always null
    ,
    
    ticketType (string):
    Always null
    ,
    
    ticketStatus (string):
    Always null
    ,
    
    hotelId (number):
    Hotel id
    ,
    
    subject (string):
    Always null
    ,
    
    campaignMessageId (number):
    Always null
    ,
    
    reservationId (number):
    Always null
    ,
    
    ticketReservationId (number):
    Always null
    }
    Example
    
    { "author": "system", "kind": "status", "id": 0, "type": "HotelUpdate", "ticket": null, "conv": null, "text": "", "status": null, "ticketRejected": false, "hide": true, "facility": null, "time": 1487362609362, "owner": null, "terminalState": null, "windowId": null, "ticketUnreadGuestMessages": null, "ticketType": null, "ticketStatus": null, "hotelId": 6, "subject": null, "campaignMessageId": null, "reservationId": null, "ticketReservationId": null }
TicketsUpdated
- - TicketsUpdated event type
    
    This event is sent on tickets change by system. Should be ignored
ArrivalsUpdated
- - ArrivalsUpdated event type
    
    This event is sent on arrivals change by system. Should be ignored
EscalationPopup
- - EscalationPopup event type
    
    This event is for internal use. Should be ignored
EscalationInApp
- - EscalationInApp event type
    
    This event is for internal use. Should be ignored
ShiftLog
- - ShiftLog event type
    
    This event is for internal use. Should be ignored
UserActivityUpdate
- - UserActivityUpdate event type
    
    This event is for internal use. Should be ignored
NewInventoryItem
- - NewInventoryItem event type
    
    This event is for internal use. Should be ignored
Campaign
- - Campaign event type
    
    This event is for internal use. Should be ignored

RequestUpdate event type

Model Description

Example

GuestRequestCreatedByStaff event type

Model Description

Example

TicketComment event type

Model Description

Example

HotelUpdate event type

Model Description

Example

TicketsUpdated event type

ArrivalsUpdated event type

EscalationPopup event type

EscalationInApp event type

ShiftLog event type

UserActivityUpdate event type

NewInventoryItem event type

Campaign event type