Keycafe

Keycafe Documentation

Welcome to the Keycafe developer hub. You'll find comprehensive guides and documentation to help you start working with Keycafe as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Guides    API Reference

Notifications

How we notify you and how to modify your notification settings

The communications menu is where you can easily see when we communicate with you and it allows you to enable or disable specific communications. Additionally, you are able to request samples of the notifications that your guests will receive, so you can see exactly what kind of communications experience they have when accessing your keys.

Proceed with the following steps to customize your communications settings:

1. Log into your Keycafe account.

2. Select the More menu option.

2. Select Communications.

Customize your preferences

By default, all the communications notices are enabled. You can easily switch them off by toggling the on/off button for each notice. Please note that there are three mandatory notices that cannot be disabled:

  • Security & Service Related
  • New Access & Setup
  • Return Key Reminders

In this article, we provide an overview of each setting, outlining in which cases Keycafe will notify you if that setting is enabled. We also explain why some of our communications services are mandatory. We recommend leaving all notifications enabled, as this will result in the smoothest key exchange experience for you.

Key Pickups

The Key Pickups setting notifies you via email when any of your keys are picked up from a SmartBox.

Recommendation

For security purposes, we recommend leaving this notice enabled so that you always have a real time update when your keys are picked up.

Key Drop Offs

The Key Drop Offs setting notifies you via email when your guest has dropped off your key at a SmartBox. This is a useful option for keeping track of your keys and planning schedules.

Security & Service Related

Keycafe will send you transactional and informational notices regarding security, your account, and the service. Please note that this notice cannot be disabled, as it is important for us to efficiently communicate with you about the security of your keys and the service.

New Locations in My Area

We will notify you via email about any SmartBox locations that are launching close to where you live. Leave this option on to keep track of where we are expanding near you.

Product Announcements

The Product Announcements setting ensures that you receive notifications about how Keycafe is evolving and improving our services. We will notify you about new updates, features, and product launches, keeping you at the forefront of our services.

Keycafe Offers

The Keycafe Offers setting ensures that you receive updates about any events, promotions, discounts, and marketing offers from Keycafe. With this option enabled, you may also receive offers from selected third-party partners.

Private Location Issue

You are able to receive notifications, via a text message and email, when a SmartBox at your private location is experiencing issues such as going offline or losing power. You will also be notified when the issue is resolved and the SmartBox is returned to a healthy state.

New Access & Setup

Guests are sent instructions and information when you provide them an access. Please note that this communication option cannot be disabled if you are using the service via our application. If you are an enterprise building an application, there are options to white-label the communications.

Return Key Reminders

We will notify your guests to return their key back to the Keycafe SmartBox before their scheduled access ends. You are able to control this setting when you create the access.

Access Starting Reminders

We will notify guests when their scheduled access begins. They will receive a notification stating that they are now able to pick up the keys from the designated SmartBox.

Access Modified or Canceled

This setting notifies guests if you decide to cancel or modify their access. This includes any modifications to the dates and times of their access.

What Your Guest Sees

For all of the guest notifications, select Send Me a Sample from the communications menu to receive a sample of the email and/or SMS message that your guest will receive.


Notifications


How we notify you and how to modify your notification settings

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.