The event resource

{
  "id": "123",
  "type": "event",
  "url": "https://example.ilucca.net/lucca-api/events/123",
  "apiVersion": "2024-01-01",
  "topic": "leave.updated",
  "occurredAt": "2024-02-01T09:34:23.001Z",
  "source": "https://example.ilucca.net",
  "businessEstablishment": {
    "id": "12",
    "type": "business-establishment",
    "url": "https://example.ilucca.net/lucca-api/business-establishments/12"
  },
  "data": {
    "id": "875",
    "type": "leave",
    "url": "https://example.ilucca.net/lucca-api/leaves/875",
    "startsOn": "2024-02-01",
    "startPosition": "firstHalfDay",
    "endsOn": "2024-02-02",
    "endPosition": "secondHalfDay",
    "employee": {
      "id": "416",
      "type": "employee",
      "url": "https://example.ilucca.net/lucca-api/employees/416"
    },
    "leaveAccount": {
      "id": "56",
      "type": "leave-account",
      "url": "http://example.ilucca.net/lucca-api/leave-account/56"
    },
    "days": [
      {
        "date": "2024-02-01",
        "range": "allDay",
        "duration": {
          "iso": "P1D",
          "value": 1,
          "unit": "days"
        }
      },
      {
        "date": "2024-02-02",
        "range": "allDay",
        "duration": {
          "iso": "P1D",
          "value": 1,
          "unit": "days"
        }
      }
    ],
    "totalDuration": {
      "iso": "P2D",
      "value": 2,
      "unit": "days"
    },
    "status": "tentative",
    "details": null,
    "createdAt": "2024-01-01T08:23:56.234Z",
    "lastUpdatedAt": "2024-01-01T08:23:56.234Z"
  },
  "previousAttributes": {
    "status": "confirmed"
  },
  "links": {
    "retry": {
      "href": "https://example.ilucca.net/lucca-api/webhook-deliveries"
    }
  }
}

Represents a change made to the state of a resource.

string

required

Unique string identifier of this event.

type

string

required

Allowed value: "event"

url

string<uri>

required

Absolute URL for the event resource.

topic

required

List of topics 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"

Examples:

"employee.created"

occurredAt

string<date-time>

required

Timezoned timestamp of the moment when this event occurred.

source

string<uri>

required

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

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.

apiVersion

string<date>

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.

businessEstablishment

object | null

Business Establishment of the Resource in the Event, if there is one. Reference to a business-establishment resource.

Show child attributes

Examples:

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

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

links

object

Show child attributes

Types of events

The webhook-endpoint resource

Overview

Organization

Employee Records

Events & Webhooks

The event resource