Ping a webhook-endpoint

Community

Status

Documentation

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

POST

lucca-api

webhook-deliveries

curl --request POST \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/webhook-deliveries \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

{
  "id": "78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
  "type": "<string>",
  "url": "<string>",
  "nextAttemptAt": "2023-08-29T09:12:33.001Z",
  "attemptsCount": 2,
  "status": "delivered",
  "event": {
    "id": "2455623",
    "type": "leave.created",
    "url": "https://example.ilucca.net/lucca-api/events/2455623"
  },
  "webhookEndpoint": {
    "id": "12",
    "type": "webhook-endpoint",
    "url": "https://example.ilucca.net/lucca-api/webhook-endpoints/d290f1ee-6c54-4b01-90e6-d701748f0851"
  },
  "links": {
    "attempts": {
      "href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=1234"
    }
  },
  "embedded": {
    "event": {}
  }
}

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.

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

201

application/json

Created

The created webhook-delivery resource.

string

required

Uniquely identifies the webhook-delivery.

Example:

"78fa5d8c-3436-49aa-82cc-ab1a64c48ed9"

type

string

required

Allowed value: "webhook-delivery"

url

string

required

nextAttemptAt

string

required

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

Example:

"2023-08-29T09:12:33.001Z"

attemptsCount

integer

required

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

Required range: x >= 0

Example:

2

status

enum<string>

required

Indicates whether the event has been delivered or not.

Available options:

delivered,

undelivered,

failed

event

object

required

Reference to an (webhook-)event resource.

Example:

{
  "id": "2455623",
  "type": "leave.created",
  "url": "https://example.ilucca.net/lucca-api/events/2455623"
}

webhookEndpoint

object

required

Reference to a webhook-endpoint resource.

Example:

{
  "id": "12",
  "type": "webhook-endpoint",
  "url": "https://example.ilucca.net/lucca-api/webhook-endpoints/d290f1ee-6c54-4b01-90e6-d701748f0851"
}

links

object | null

embedded

object | null

embedded.event

object | null

Dictionary of events objects indexed by ID.

embedded.event.{key}

object

Represents a change made to the state of a resource.

embedded.event.{key}.id

string

required

Unique string identifier of this event.

embedded.event.{key}.type

string

required

Allowed value: "event"

embedded.event.{key}.url

string

required

Absolute URL for the event object.

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:

"leave.created"

embedded.event.{key}.occurredAt

string

required

Timezoned timestamp of the moment when this event occurred.

embedded.event.{key}.source

string

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}.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.

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

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, 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

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

Was this page helpful?

curl --request POST \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/webhook-deliveries \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

{
  "id": "78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
  "type": "<string>",
  "url": "<string>",
  "nextAttemptAt": "2023-08-29T09:12:33.001Z",
  "attemptsCount": 2,
  "status": "delivered",
  "event": {
    "id": "2455623",
    "type": "leave.created",
    "url": "https://example.ilucca.net/lucca-api/events/2455623"
  },
  "webhookEndpoint": {
    "id": "12",
    "type": "webhook-endpoint",
    "url": "https://example.ilucca.net/lucca-api/webhook-endpoints/d290f1ee-6c54-4b01-90e6-d701748f0851"
  },
  "links": {
    "attempts": {
      "href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=1234"
    }
  },
  "embedded": {
    "event": {}
  }
}