Skip to main content
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.
Webhooks are a closed enterprise feature. Contact hello@breakroomapp.com for access.
Payload schemas for each event are under Webhooks in the API Reference.

​
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.

​
Features