Search Events

Retrieve data for multiple events with a GET request to the endpoint.

At least one search property must be provided. Omitting all search properties will result in an error.

The results will be sorted by date and time, descending.

Results are limited to 50 per page, with additional pages available via the Link response header:

Link: <https://www.keycafe.com/v0/event?key=123456&page=2>; rel="next", <https://www.keycafe.com/v0/event?key=123456&page=5>; rel="last"

Notifications

To receive event notifications, configure a webhook endpoint URL and Basic Auth credentials in your account settings.

When a notification is received, respond with status code 200. If any other response code or error is encountered, Keycafe will try to deliver the notification again (up to 10 attempts) using exponential back-off to increase the time between each attempt.

Notifications are delivered as POST requests to the configured endpoint. Each POST body contains a single event in the same JSON format as above. Only exchange events (PICKUP/DROPOFF) for the user's own keys are sent as notifications.

Language
Credentials
Basic
base64
: