Skip to main content

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, otherwise, the server may stop sending it events.

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

​
name
string
required
Minimum string length: 1
​
apiVersion
string<date>
required
​
webhookUrl
string<uri>
required

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

​
topics
string[]
required

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
​
links
object