> ## Documentation Index
> Fetch the complete documentation index at: https://docs.breakroomapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> How Breakroom delivers webhook events to your endpoint.

Breakroom can `POST` events (for example `time_off_approved`) to your HTTPS
endpoint when enterprise data changes. Each subscription covers one feature
(`featureType`) and the event types you choose.

> [!NOTE]
>
> Webhooks are a closed enterprise feature. Contact
> [hello@breakroomapp.com](mailto:hello@breakroomapp.com) for access.

Payload schemas for each event are under **Webhooks** in the
[API Reference](https://docs.breakroomapp.com/api-reference/webhooks/time-off-created.md).

## Delivery

* Method `POST`, `Content-Type: application/json`.
* If the subscription has a `secretKey`, it is sent in the
  `x-webhook-secret` header. Reject requests where it doesn't match your
  stored secret.
* Respond with any `2xx` status within **10 seconds** to acknowledge the
  delivery.

## Matching

A subscription receives an event when all of the following are true:

* `entId` matches the enterprise where the change happened,
* `featureType` matches the event's feature (for example `time_off`),
* `eventTypes` includes the event's `eventType`,

## Retries

* Non-`2xx` responses, network errors, and timeouts are retried
  immediately, up to `retryLimit` times (default `3`, for 4 attempts total).
* `404` responses are treated as permanent and are **not** retried.
* Deliveries may arrive out of order or more than once. Use `requestId` and
  `data.id` to de-duplicate.

## Payload

Every event has the same top-level fields. IDs inside `data` (`id`, `orgId`,
`assigneeId`, `createdBy`, `updatedBy`) are **hashed** strings, in the same
format the Open API endpoints return. UUIDs are sent unchanged.

```json theme={null}
{
  "eventType": "time_off_approved",
  "requestId": "6f1c2a8e-3b1d-4b7a-9d0e-2f5c8a1b4e7d",
  "enterprise": "Acme Corp",
  "featureType": "time_off",
  "eventTimestamp": 1767225600,
  "data": { "id": "evt_x5p7l3tg", "status": "approved" }
}
```

## Features

* [Time off](https://docs.breakroomapp.com/guides/webhooks/time-off.md) — `featureType: time_off`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.