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.

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

Was this page helpful?