Listen for events on your Lucca account so your integration can automatically react in near real-time.

​
Why Should You Use Webhooks?

Webhooks offer some advantages compared to regular polling:
  • polling to the REST API is often inefficient;
  • polling may result in timing conflicts;
  • webhooks reduce the delay between the moment a change occurs and the moment your integration reacts;
  • webhooks reduces the number of HTTP request, and as such reduce the risk of exceeding our rate-limit

​
Events Overview

Most of the resources in the Lucca API are subject to events. This means whenever their state changes, an event object is created and can be sent to your webhook-endpoint. Please note that a single change in the API may result in the creation of several events, for example, creating a new employee results in the creation of:
  • an employee.created event (this is what triggered this chain reaction) ;
  • an employment.created event (an employee must have at least one employment, which is created along the employee) ;
  • a job-position.created event (for the same reasons).
By registering your webhook endpoints in your Lucca account, these events can be automatically sent to you through HTTP POST requests.
Please note that an event is only created when the instrinsic attributes of a resource change. As a result, changing an employee’s given name will not trigger a leave.updated event even if the employee representation might be embedded into the leave representation.

​
At-least-once Guarantee

Regarding event delivery, there is only one guarantee: each event will be delivered at-least-once to your webhook endpoint. This means:
  • an event may be delivered several times, due to the retry feature, and as such, you should consider idempotency when handling them.
  • there is no guarantee regarding the order of events: you may receive an “update” event for a resource whose “created” event will arrive later. You should use the occurredAt UTC timestamp attribute of events in order to reorder them.