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.

id
string
required
Minimum length: 1
type
string
required
Allowed value: "webhook-endpoint"
url
string
required
webhookUrl
string
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.

status
enum<string>
default:inactive
required

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

Available options:
active,
suspended,
inactive
apiVersion
string
contentType
enum<string>
default:default
Available options:
default,
cloudEvents
createdAt
string

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

Example:

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

lastUpdatedAt
string

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"

Was this page helpful?