Webhook Payload Format

*** This article is intended for technical audiences ***

All data published by the webhook service uses JSON (javascript object notation) structuring.

The payload consists of a base model that contains a Data property which contains the actual transaction data.   The base model will contain a Type field that identifies that transaction type.

This is an example of a check in event:

  "CompanyID": "DEMO0001",
  "UTCPublishDate": "2020-04-27T14:44:13.4485605Z",
  "Data": {
    "RequestID": 6688,
    "DateTimeIn": "2020-04-27T10:44: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": 40,
      "Description": "Application for Admission"
  "Type": "check_in"
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us