Contact Object
{
"_id": [String],
"category": "cheqroom.types.customer",
"fields": { [Map of Custom Fields] },
"by": [String],
"created": [ISO DateTime],
"modified": [ISO DateTime],
"isSample": false,
"name": [String],
"kind": [user | contact],
"status": [String],
"email": [String],
"blocked": [ISO DateTime | null],
"archived": [ISO DateTime | null],
"user": [String | null],
"contactGroups": [
[String of Equipment Access Group Ids]
],
"role": [String],
"workspaceAccess": [Boolean],
"lastLogin": [ISO DateTime],
"doc_url": [URL to resource],
"company": [String],
"phone": [String],
"barcode": [String],
"barcode_text": [String],
"barcode_url": [url],
"custody": [
[String]
],
"created_date": "[YYYY-MM-DD]",
"created_datetime": "[YYYY-MM-DD HH SS]",
"created_timestamp": [Unix timestamp],
"created_human": "[# days ago: String]",
"created_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"modified_date": "[YYYY-MM-DD]",
"modified_datetime": "[YYYY-MM-DD HH SS]",
"modified_timestamp": [Unix timestamp],
"modified_human": "[# days ago: String]",
"modified_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]"
"lastLogin_date": "[YYYY-MM-DD]",
"lastLogin_datetime": "[YYYY-MM-DD HH SS]",
"lastLogin_timestamp": [Unix timestamp],
"lastLogin_human": "[# days ago: String]",
"lastLogin_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]"
}
Location Object
{
"_id": "[String]",
"category": "cheqroom.types.location",
"by": "[String]",
"created": [ISO DateTime],
"modified": [ISO DateTime],
"name": [String],
"status": [String],
"address": [String],
"geo": [[float], [float]],
"created_date": "[YYYY-MM-DD]",
"created_datetime": "[YYYY-MM-DD HH SS]",
"created_timestamp": [Unix timestamp],
"created_human": "[# days ago: String]",
"created_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"modified_date": "[YYYY-MM-DD]",
"modified_datetime": "[YYYY-MM-DD HH SS]",
"modified_timestamp": [Unix timestamp],
"modified_human": "[# days ago: String]",
"modified_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]"
}
Item Object
{
"_id": [String],
"category": "cheqroom.types.item",
"fields": { [Map of Custom Fields] },
"by": [String],
"created": [ISO DateTime],
"modified": [ISO DateTime],
"name": [String],
"codes": [[Array of strings of QR Codes]],
"status": "[String]",
"kind": "[bulk | simple]",
"quantity": [Number: quantity in system],
"fields": { [Map of Custom Fields] },
"brand": "[string]",
"model": "[string]",
"warrantyDate": [ISO DateTime | Null],
"purchaseDate": [ISO DateTime | Null],
"purchasePrice": [Float],
"residualValue": [Float],
"depreciatedValue": [Float | null],
"geo": [Last known [Float], [Float]],
"address": Last Known: [String],
"expired": [ISO DateTime | Null],
"itemTypeId": "[String]",
"location": "[String]",
"order": "Check-out id: [String]",
"flaggedUnavailable": [Boolean],
"kitQuantities": [{$kitId: $quantity}],
"inKits": Quantity associated in kits [Number],
"kit": [AlphaNumeric: Associated Kit Id],
"orders": { "[AlphaNumeric: Current Checkout Id]": [Number: Quantity] },
"doc_url": "[URL: Platform url to resource]",
"last_comment_text": "[AlphaNumeric]",
"last_attachment_url": "[URL]",
"flag_id": "[AlphaNumeric: Item ID]",
"flag_color": "[AlphaNumeric: Color]",
"flag_color_hex": "[AlphaNumeric]",
"flag_description": "[AlphaNumeric]",
"flag_available": "[available | unavailable]",
"last_set_flag_message": "[AlphaNumeric]",
"itemType": "[AlphaNumeric: Name]",
"qrcode_or_barcode": "[AlphaNumeric]",
"barcode_or_qrcode": "[AlphaNumeric]",
"code": "[AlphaNumeric]",
"qrcode_text": "[AlphaNumeric]",
"qrcode_url": "[URL]",
"barcode": [AlphaNumeric],
"barcode_text": [AlphaNumeric],
"barcode_url": "[URL]",
"image_url_XS": "[URL]",
"image_url_S": "[URL]",
"image_url_M": "[URL]",
"image_url_L": "[URL]",
"created_date": "[YYYY-MM-DD]",
"created_datetime": "[YYYY-MM-DD HH SS]",
"created_timestamp": [Unix timestamp],
"created_human": "[# days ago: String]",
"created_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"modified_date": "[YYYY-MM-DD]",
"modified_datetime": "[YYYY-MM-DD HH SS]",
"modified_timestamp": [Unix timestamp],
"modified_human": "[# days ago: String]",
"modified_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]"
}
Check-out Object
{
"_id": "[String]",
"category": "cheqroom.types.order",
"fields": { [Map of Custom Fields] },
"comments": [],
"created": "[ISO DateTime]",
"items": [ Array of [Item Object] ],
"status": "[status label: String]",
"started": "[ISO DateTime]",
"due": "[ISO DateTime]",
"finished": [ISO DateTime],
"location": [Location Object],
"customer": Assigned [Contact Object],
"itemSummary": [String],
"name": [String],
"number": Check-out key [String],
"reservation": [String of reservation created from | Null],
"archived": [ISO DateTime | null],
"itemQuantities": { "Item ID [String]": [Number] },
"itemQuantitiesWithKits": [{}],
"finished_or_due": [ISO DateTime | Null],
"doc_url": [URL to resource],
"last_comment_text": [String],
"last_attachment_url": [URL],
"label_name": [String],
"label_color": [String],
"label_color_hex": [String],
"label_image_XS": [URL],
"label_image_S": [URL],
"label_image_L": [URL],
"label_image_XL": [URL],
"name_or_summary": [String],
"calendar_event_name": [String],
"group": Workspace ID [String],
"item_summary": [String],
"item_count": [Number],
"qrcode_url": [URL],
"checked_in_fully_or_partially": [String],
"checked_in_item_count": [Number],
"checked_out_item_count": [Number],
"created_date": "[YYYY-MM-DD]",
"created_datetime": "[YYYY-MM-DD HH SS]",
"created_timestamp": [Unix timestamp],
"created_human": "[# days ago: String]",
"created_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"modified_date": "[YYYY-MM-DD]",
"modified_datetime": "[YYYY-MM-DD HH SS]",
"modified_timestamp": [Unix timestamp],
"modified_human": "[# days ago: String]",
"modified_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"started_date": "[YYYY-MM-DD]",
"started_datetime": "[YYYY-MM-DD HH SS]",
"started_timestamp": [Unix timestamp],
"started_human": "[# days ago: String]",
"started_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"due_date": "[YYYY-MM-DD]",
"due_datetime": "[YYYY-MM-DD HH SS]",
"due_timestamp": [Unix timestamp],
"due_human": "[# days ago: String]",
"due_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"finished_or_due_date": "[YYYY-MM-DD]",
"finished_or_due_datetime": "[YYYY-MM-DD HH SS]",
"finished_or_due_timestamp": [Unix timestamp],
"finished_or_due_human": "[# days ago: String]",
"finished_or_due_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"now": [ISO DateTime],
"now_date": "[YYYY-MM-DD]",
"now_datetime": "[YYYY-MM-DD HH SS]",
"now_timestamp": [Unix timestamp],
"now_human": "[# days ago: String]",
"now_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"account": [String],
"currency": [String],
}
Reservation Object
{
"_id": "[String]",
"category": "cheqroom.types.reservation",
"fields": { [Map of Custom Fields] },
"comments": [],
"created": "[ISO DateTime]",
"items": [ Array of [Item Object] ],
"status": "[status label: String]",
"started": "[ISO DateTime]",
"due": "[ISO DateTime]",
"finished": [ISO DateTime],
"location": [Location Object],
"customer": Assigned [Contact Object],
"itemSummary": [String],
"name": [String],
"number": Reservation key [String],
"archived": [ISO DateTime | null],
"itemQuantities": { "Item ID [String]": [Number] },
"itemQuantitiesWithKits": [{}],
"finished_or_due": [ISO DateTime | Null],
"doc_url": [URL to resource],
"last_comment_text": [String],
"last_attachment_url": [URL],
"label_name": [String],
"label_color": [String],
"label_color_hex": [String],
"label_image_XS": [URL],
"label_image_S": [URL],
"label_image_L": [URL],
"label_image_XL": [URL],
"name_or_summary": [String],
"calendar_event_name": [String],
"group": Workspace ID [String],
"item_summary": [String],
"item_count": [Number],
"reserve_date": "[YYYY-MM-DD]",
"reserve_timestamp": [Unix timestamp],
"reserve_human": "[# days ago: String]",
"fromDate_timestamp": [Unix timestamp],
"fromDate_human": "[# days ago: String]",
"fromDate_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"toDate_timestamp": [Unix timestamp],
"toDate_human": "[# days ago: String]",
"toDate_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"now": [ISO DateTime],
"now_date": "[YYYY-MM-DD]",
"now_datetime": "[YYYY-MM-DD HH SS]",
"now_timestamp": [Unix timestamp],
"now_human": "[# days ago: String]",
"now_friendly": "[Month, D YYYY HH:SS [AM/PM] (Timezone)]",
"account": [String],
"currency": [String],
}
Payload for Check-outs Webhooks
{
"data": [Check-out Object],
"time": Event trigger [Unix Timepstamp],
"id": Event ID [String],
"name": [String],
"topic": "order.checkout",
"kind": "order"
}
Payload for Item Webhooks
{
"data": [Item Object],
"time": Event trigger [Unix Timepstamp],
"id": Event ID [String],
"name": [String],
"topic": "item.[method]",
"kind": "item"
}
Payload for Contact Webhooks
{
"data": [Contac Object],
"time": Event trigger [Unix Timepstamp],
"id": Event ID [String],
"name": [String],
"topic": "contact.[method]",
"kind": "contact"
}
Payload for Contact Webhooks
{
"data": [Contac Object],
"time": Event trigger [Unix Timepstamp],
"id": Event ID [String],
"name": [String],
"topic": "contact.[method]",
"kind": "contact"
}
Payload for Reservation Webhooks