Ping a webhook-endpoint

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

Allowed value: "2024-11-01"

Maximum string length: 10

If-None-Match

string

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

If-Match

string

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

Accept-Encoding

string

List of compression algorithms you support.

Query Parameters

webhookEndpoint.id

string

required

The identifier of the webhook-endpoint the event should be sent to.

event.topic

enum<string>

default:ping

Type of event to send.

Available options:

ping

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.

Body

application/json

The webhook-delivery to create.

A webhook-delivery is the object that represents the job to send an event to a webhook-endpoint. It will lead to one or more webhook-delivery-attempt.

event

event-reference · object

required

Reference to an (webhook-)event resource.

Show child attributes

event.id

string

required

event.type

List of topics

Allowed value: "confirmation"

webhookEndpoint

webhook-endpoint-reference · object

required

Reference to a webhook-endpoint resource.

Show child attributes

webhookEndpoint.id

string

required

Minimum string length: 1

nextAttemptAt

string<date-time>

Timestamp of the next planned webhook-delivery-attempt (UTC).

attemptsCount

integer<int32>

Number of times this event has been attempted to be delivered.

Required range: x >= 0

status

enum<string>

Indicates whether the event has been delivered or not.

Available options:

delivered,

undelivered,

failed

Response

Created

The created webhook-delivery resource.

event

event-reference · object

required

Reference to an (webhook-)event resource.

Show child attributes

event.id

string

required

event.type

List of topics

Allowed value: "confirmation"

event.url

string<uri>

webhookEndpoint

webhook-endpoint-reference · object

required

Reference to a webhook-endpoint resource.

Show child attributes

webhookEndpoint.id

string

required

Minimum string length: 1

webhookEndpoint.type

string

Allowed value: "webhook-endpoint"

webhookEndpoint.url

string<uri>

id

string

Uniquely identifies the webhook-delivery.

type

string

Allowed value: "webhook-delivery"

url

string<uri>

nextAttemptAt

string<date-time>

Timestamp of the next planned webhook-delivery-attempt (UTC).

attemptsCount

integer<int32>

Number of times this event has been attempted to be delivered.

Required range: x >= 0

status

enum<string>

Indicates whether the event has been delivered or not.

Available options:

delivered,

undelivered,

failed

links

object

Show child attributes

links.attempts

object

Show child attributes

links.attempts.href

string<uri>

embedded

object

Show child attributes

embedded.event

object

Dictionary of events objects indexed by ID.

Show child attributes

embedded.event.{key}

event · object

Represents a change made to the state of a resource.

Show child attributes

embedded.event.{key}.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:

"employee.created"

embedded.event.{key}.occurredAt

string<date-time>

required

Timezoned timestamp of the moment when this event occurred.

embedded.event.{key}.source

string<uri>

required

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

embedded.event.{key}.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.

embedded.event.{key}.id

string

Unique string identifier of this event.

embedded.event.{key}.type

string

Allowed value: "event"

embedded.event.{key}.url

string<uri>

Absolute URL for the event resource.

embedded.event.{key}.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.

embedded.event.{key}.businessEstablishment

business-establishment-reference · object

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

Show child attributes

embedded.event.{key}.businessEstablishment.id

string

required

Minimum string length: 1

embedded.event.{key}.businessEstablishment.type

enum<string>

Available options:

business-establishment

Allowed value: "business-establishment"

embedded.event.{key}.businessEstablishment.url

string<uri>

embedded.event.{key}.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.

embedded.event.{key}.links

object

Show child attributes

embedded.event.{key}.links.retry

object

Show child attributes

embedded.event.{key}.links.retry.href

string<uri>

Example:

{
  "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"
    }
  }
}

Overview

Organization

Employee Records

Events & Webhooks

Ping a webhook-endpoint

Authorizations

Headers

Query Parameters

Body

Response