Retrieve an event
Retrieve an event by its ID.
Access
Access
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Set the API version.
2024-11-01 "2024-11-01"10"2024-11-01"
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Path Parameters
Identifier of the event to retrieve.
Query Parameters
Include metadata:
embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links: links to related resources or actions (e.g. approving a leave-request). May benullwhen you do not have access to the resource (or action).totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
embedded, links, totalCount Response
OK
An event resource.
Unique string identifier of this event.
"event"Absolute URL for the event resource.
API version of the resource representation contained in data. Not to be confused with the API version of the representation of this present event, which is indicated in the Api-Version HTTP header.
Indicates which type of event occurred. Usually concatenates the name of the object type with the kind of change ("created", "updated" or "deleted").
"test.created""employee.created"
Timezoned timestamp of the moment when this event occurred.
URL of the tenant. Ensures unicity of {source} + {id}.
Representation of the resource whose change triggered the event. Please note that this is the representation of the resource just after the change, and it may have changed again since then.
Business Establishment of the Resource in the Event, if there is one.
Only sent on *.updated event topics. Keys are the list of modified attributes. Values are the values of these attributes before the change.
This is only available for some resources. If a value in the dictionary is NULL, then it can either mean that the original value was NULL or that we can't retrieve them for this Resource.
No embedded resources on a event(s) response. Expect an empty object if embedded are requested.