Setting up a Webhook

  • Click Settings, next click Webhooks
  • 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.setflag  Triggered when an Item flag was just updated
item.clearflag  Triggered when an Item flag was just cleared

Contacts

contact.create  Triggered when a Contact was just created
contact.update  Triggered when a Contact was just updated

Reservations

reservation.reserve Triggered when a Reservation was just made
reservation.cancel  Triggered when a Reservation was just cancelled
reservation.due_in_1_hour  Triggered when a Reservation is due for pickup in 1 hour
reservation.due_in_1_day  Triggered when a Reservation is due for pickup in 1 day
reservation.overdue_1_hour  Triggered when a Reservation was due for pickup 1 ago
reservation.overdue_1_day Triggered when a Reservation was due for pickup 1 day ago

Check-outs

order.checkout  Triggered when an Check-out was just checked out
order.checkin  Triggered when an Check-out was just (partially) checked in
order.undocheckout  Triggered when an Check-out was undone
order.due_in_1_hour
 Triggered when an Check-out is due in 1 hour
order.due_in_1_day  Triggered when an Check-out is due in 1 day
order.overdue_1_hour  Triggered when an Check-out was due 1 hour ago
order.overdue_1_day  Triggered when an Check-out was due 1 day ago'}

Did this answer your question?