List events

Returns a paginated list of events.

You can retrieve events formatted as CloudEvents through content negotiation:

GET /lucca-api/events HTTPS/2
Host: example.ilucca.net
Authorization: Bearer <token>
Accept: application/cloudevents-batch+json

GET

lucca-api

events

curl --request GET \
  --url https://{host}/lucca-api/events \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

{
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

enum<string>

Both application/json and application/cloudevents-batch+json are accepted.

Available options:

application/json,

application/cloudevents-batch+json

Query Parameters

include

enum<string>[]

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 be null when 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.

Response

200

application/json

A collection of event resources.

type

string

required

Allowed value: "events"

url

string

required

items

object[]

required

Paginated list of event resources.

Represents a change made to the state of a resource.

items.id

string

required

Unique string identifier of this event.

items.type

string

required

Allowed value: "event"

items.url

string

required

Absolute URL for the event object.

items.topic

required

Indicates which type of event occurred. Usually concatenates the name of the object type with the kind of change ("created", "updated" or "deleted").

Allowed value: "confirmation"

Example:

"leave.created"

items.occurredAt

string

required

Timezoned timestamp of the moment when this event occurred.

items.source

string

required

URL of the tenant. Ensures unicity of {source} + {id}.

items.data

object

required

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.

items.apiVersion

string

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.

items.businessEstablishment

object | null

Business Establishment of the Resource in the Event, if there is one.

Example:

{
  "id": "5",
  "type": "business-establishment",
  "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
}

items.previousAttributes

object

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, it can either mean that the original value was NULL or that we can't retrieve them for this Resource.

items.links

object

totalCount

integer | null

Total number of event resources across all pages that satisfy query parameters.

Required range: x >= 0

embedded

null

links

object | null

Links to related resources

Was this page helpful?

curl --request GET \
  --url https://{host}/lucca-api/events \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

{
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}