The webhook-delivery resource

{
  "id": "78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
  "type": "webhook-delivery",
  "url": "https://example.ilucca.net/lucca-api/webhook-deliveries/78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
  "nextAttemptAt": "2023-08-29T09:12:33.001Z",
  "attemptsCount": 2,
  "status": "delivered",
  "event": {
    "id": "2455623",
    "type": "leave.created",
    "url": "https://example.ilucca.net/lucca-api/events/2455623"
  },
  "webhookEndpoint": {
    "id": "12",
    "type": "webhook-endpoint",
    "url": "https://example.ilucca.net/lucca-api/webhook-endpoints/12"
  },
  "links": {
    "attempts": {
      "href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=78fa5d8c-3436-49aa-82cc-ab1a64c48ed9"
    }
  }
}

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

object

required

Reference to an (webhook-)event resource.

Show child attributes

Examples:

{
  "id": "2455623",
  "type": "employee.created",
  "url": "https://example.ilucca.net/lucca-api/events/2455623"
}

webhookEndpoint

object

required

Reference to a webhook-endpoint resource.

Show child attributes

string

Uniquely identifies the webhook-delivery.

type

string

Allowed value: "webhook-delivery"

url

string<uri>

nextAttemptAt

string<date-time>

Timestamp of the next planned webhook-delivery-attempt (UTC).

attemptsCount

integer

Number of times this event has been attempted to be delivered.

Required range: x >= 0

Examples:

2

status

enum<string>

Indicates whether the event has been delivered or not.

Available options:

delivered,

undelivered,

failed

links

object | null

Show child attributes

Delete a webhook-endpoint

List webhook-deliveries

⌘I

Overview

Organization

Employee Records

Events & Webhooks

The webhook-delivery resource