The webhook-endpoint resource

{
  "id": "456789412",
  "type": "webhook-endpoint",
  "url": "https://example.ilucca.net/lucca-api/webhook-endpoints/93847DF7FDSF6D87SF",
  "name": "Test",
  "apiVersion": "2024-11-01",
  "webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
  "topics": [
    "employee.created",
    "employee.updated",
    "employee.deleted"
  ],
  "status": "active",
  "createdAt": "2023-04-23T09:23:54.001Z",
  "lastUpdatedAt": "2023-04-23T09:23:54.001Z",
  "links": {}
}

A webhook-endpoint describes the endpoint on your side that will receive events from your Lucca account.

It must handle HTTPS and support POST requests.

It should always check the signature of received events in order to increase security.

It should respond as fast as possible (less than 3s), otherwise the server may stop sending it events.

Please refer to the webhooks documentation to learn more about webhook-endpoints.

string

Minimum string length: 1

type

string

Allowed value: "webhook-endpoint"

url

string<uri>

name

string

Minimum string length: 1

apiVersion

string<date>

webhookUrl

string<uri>

URL of the receiving endpoint on your side. MUST use the https:// schema.

topics

string[]

See complete list of all topics in the event definition.

businessEstablishments

null | business-establishment-reference · object[]

Restrict events to those belonging to one of the given business-establishments. null should be interpreted as "all business establishments".

Minimum array length: 1

Show child attributes

status

enum<string>

default:inactive

'active': delivery attempts will be executed. 'suspended': if too many errors are encountered on delivery. Events are kept in history. 'inactive': events are neither sent nor kept in history.

Available options:

active,

suspended,

inactive

createdAt

string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt

string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

links

object

Test event (test.created)

List webhook-endpoints

⌘I

Overview

Files

Organization

Employee Records

Events & Webhooks

The webhook-endpoint resource