Webhook Events
check_in
Occurs when a customer has checked in.
Response
{ "CompanyID": "DEMO0001", "UTCPublishDate": "2020-04-27T14:58:23.5795926Z", "Data": { "RequestID": 6690, "DateTimeIn": "2020-04-27T10:58:00", "DateTimeSeen": "0001-01-01T00:00:00", "DateTimeOut": "0001-01-01T00:00:00", "Queue": { "QueueID": 15, "QueueName": "Financial Aid", "LocationID": 1, "LocationName": "Central Campus" }, "Customer": { "CustID": 214, "FirstName": "test", "LastName": "customer", "Email": "", "Phone": "" }, "Service": { "ServiceID": 28, "Description": "Drop off application" } }, "Type": "check_in" }
ticket_taken
Occurs when a user selects a customer waiting for service.
Response
{ "CompanyID": "DEMO0001", "UTCPublishDate": "2020-04-27T14:57:21.9264502Z", "Data": { "RequestID": 6688, "DateTimeIn": "2020-04-27T10:44:00", "DateTimeSeen": "2020-04-27T10:57:00", "DateTimeOut": "1900-01-01T00:00:00", "Queue": { "QueueID": 15, "QueueName": "Financial Aid", "LocationID": 0, "LocationName": "" }, "Customer": { "CustID": 214, "FirstName": "test", "LastName": "customer", "Email": "", "Phone": "" }, "Service": { "ServiceID": 40, "Description": "Application for Admission" } }, "Type": "ticken_taken" }
updated
Occurs when a pending or in-service ticket has been changed. e.g. visit reason
Response
{ "CompanyID": "DEMO0001", "UTCPublishDate": "2020-04-27T14:57:31.5239541Z", "Data": { "RequestID": 6688, "DateTimeIn": "2020-04-27T10:44:00", "DateTimeSeen": "2020-04-27T10:57:00", "DateTimeOut": "1900-01-01T00:00:00", "Queue": { "QueueID": 15, "QueueName": "Financial Aid", "LocationID": 1, "LocationName": "Central Campus" }, "Customer": { "CustID": 214, "FirstName": "test", "LastName": "customer", "Email": "", "Phone": "" }, "Service": { "ServiceID": 40, "Description": "Application for Admission" } }, "Type": "updated" }
check_out
Occurs when a user closes a ticket
Response
{ "CompanyID": "DEMO0001", "UTCPublishDate": "2020-04-27T14:57:40.6476902Z", "Data": { "RequestID": 6688, "DateTimeIn": "2020-04-27T10:44:00", "DateTimeSeen": "2020-04-27T10:57:00", "DateTimeOut": "2020-04-27T10:57:00", "Queue": { "QueueID": 15, "QueueName": "Financial Aid", "LocationID": 1, "LocationName": "Central Campus" }, "Customer": { "CustID": 214, "FirstName": "test", "LastName": "customer", "Email": "", "Phone": "" }, "Service": { "ServiceID": 40, "Description": "Application for Admission" } }, "Type": "check_out" }
abandoned
Occurs when a pending ticket is marked abandoned
Response
{ "CompanyID": "DEMO0001", "UTCPublishDate": "2020-04-27T14:58:39.1432725Z", "Data": { "RequestID": 6690, "DateTimeIn": "2020-04-27T10:58:00", "DateTimeSeen": "2020-04-27T10:58:00", "DateTimeOut": "2020-04-27T10:58:00", "Queue": { "QueueID": 15, "QueueName": "Financial Aid", "LocationID": 1, "LocationName": "Central Campus" }, "Customer": { "CustID": 214, "FirstName": "test", "LastName": "customer", "Email": "", "Phone": "" }, "Service": { "ServiceID": 28, "Description": "Drop off application" } }, "Type": "abandoned" }