Skip to main content

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.

Example:
{
  "id": "2455623",
  "type": "employee.created",
  "url": "https://example.ilucca.net/lucca-api/events/2455623"
}
​
webhookEndpoint
webhook-endpoint-reference · object
required

Reference to a webhook-endpoint resource.

​
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
Example:

2

​
status
enum<string>

Indicates whether the event has been delivered or not.

Available options:
delivered,
undelivered,
failed
​
links
object