Enabling the Webhooks add-on
Click Settings in the bottom left corner of your screen
Click Integrations
Go to Webhooks
Click Configure
Setting up a webhook
Click Settings, next click Integrations
Go to the Webhooks section and click Configure
Click New webhook
Give the webhook a name, pick the webhook topic and enter the the url
Click Add webhook
What's a webhook?
A webhook (also called a web callback or HTTP push API) is a way for an app like Cheqroom to provide other applications with real-time information.
A webhook delivers data to other applications as it happens, meaning you get data immediately. Unlike typical APIs where you would need to poll for data very frequently in order to get it real-time. This makes webhooks much more efficient for both provider and consumer.
What webhooks are available?
Items
item.create
Triggered when an Item was createditem.update
Triggered when a system field on an Item was updateditem.duplicate
Triggered when an Item was created by duplicating another Itemitem.setfield
Triggered when a custom field on Item was updateditem.clearfield
Triggered when a custom field on an Item was cleareditem.setflag
Triggered when an Item flag was just updateditem.clearflag
Triggered when an Item flag was just cleared
item.expire
Triggered when an Item is expired
item.undoexpire
Triggered when an Item is unexpired
item.changelocation
Triggered when an Item location was just updated
item.addcomment
Triggered when an Item comment was just added
item.takecustody
Triggered when a contact takes custody of an Item
item.transfercustody
Triggered when Item custody is transfered to another contact
item.releasecustody
Triggered when a contact releases custody of an Item
Contacts
contact.create
Triggered when a Contact was just createdcontact.update
Triggered when a Contact was just updated
contact.addcomment
Triggered when a Contact comment was just added
contact.block
Triggered when a Contact was blocked
contact.undoblock
Triggered when a Contact was unblocked
Reservations
reservation.reserve
Triggered when a Reservation was just madereservation.cancel
Triggered when a Reservation was just cancelledreservation.due_in_1_hour
Triggered when a Reservation is due for pickup in 1 hourreservation.due_in_1_day
Triggered when a Reservation is due for pickup in 1 dayreservation.overdue_1_hour
Triggered when a Reservation was due for pickup 1 agoreservation.overdue_1_day
Triggered when a Reservation was due for pickup 1 day ago
Check-outs
order.checkout
Triggered when a Check-out was just checked outorder.checkin
Triggered when a Check-out was just (partially) checked inorder.undocheckout
Triggered when a Check-out was undoneorder.due_in_1_hour
Triggered when a Check-out is due in 1 hourorder.due_in_1_day
Triggered when a Check-out is due in 1 dayorder.overdue_1_hour
Triggered when a Check-out was due 1 hour agoorder.overdue_1_day
Triggered when a Check-out was due 1 day ago'}
Signing webhooks
All webhook POST requests will include an X-CHEQROOM-Signature
header, whose value will contain an HMAC SHA256 hex digest of the webhook payload, using the signing secret as the key.
You should compute the signature of the payload using the same shared secret in your code to verify that the webhook was triggered by Cheqroom.
Important
As of now, Cheqroom doesn't support incoming webhooks.