---
updatedAt: 2025-08-11T18:18:17.000Z
agentTools:
  projectIndex: https://docs.keycafe.com/llms.txt
---

# Webhook Notification

Keycafe supports sending Event objects directly to your server through webhook notifications.

# Configuration

To enable webhook notifications:

* Navigate to **More** > **Advanced**> **API Settings** > **Webhook** in your Keycafe account settings.
* Provide a Webhook URL and Basic Authentication credentials.

# Expected Format

Once configured, Keycafe will send individual POST requests to your specified endpoint, with the event data formatted identically to the response structure of the Retrieve Event API endpoint.

### Example Payload

```json JSON
{
  "id": 123456,
  "dateCreated": "2016-07-21T12:45:21Z",
  "location": {
    "id": 123456,
    "name": "Corner Cafe",
    "timezone": "America/Vancouver",
    "address": {
      "street": "123 Main St.",
    }
  },
  "user": {
    "email": "user@yourdomain.com",
    "mobile": "16042656073",
    "firstName": "Bob",
    "lastName": "Smith"
  },
  "key": {
    "id": 123456,
    "name": "Bob's Home Key",
    "serialNumber": "XXXXX",
    "notes": "The cleaners come every Monday at 10:00",
    "pickupNote": "Don't mind the dog. He's harmless.",
    "address": {
      "street": "123 Main St.",
    }
  },
  "access": {
    "id": 123456,
    "startDate": "2016-07-21T12:45:21Z",
    "endDate": "2016-07-23T12:45:21Z",
    "returnReminder": false
  },
  "type": "PICKUP",
  "bin": "A-1"
}
```

# Supported Event Types

Only the following event types are delivered via webhook:

* PICKUP
* DROPOFF

# Delivery and Retry Logic

* A HTTP 200 OK response from your server is required to acknowledge successful receipt of a notification.
* Any other response code (non-200) will be treated as a failure.
* Upon failure, Keycafe will retry delivery up to 10 times, using an exponential backoff strategy to progressively increase the delay between retries.
* Note: The order in which webhook notifications are received is not guaranteed.

For more information, refer to [Set Up a Webhook](https://support.keycafe.com/hc/en-us/articles/360043666032-API-Configuration#h_01FV3XQ3JE81M38SK59829EWCC)