Skip to main content
POST
/
lucca-api
/
webhook-deliveries
Trigger a test delivery
curl --request POST \
  --url https://{host}/lucca-api/webhook-deliveries \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookEndpoint": {
    "id": "12"
  }
}
'
{
  "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": "event",
    "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"
    }
  },
  "embedded": {}
}
This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.
You may refer to this example of a test event
OAuth 2.0 scopes
 webhook-deliveries.readwrite

Authorizations

​
Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

​
Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Allowed value: "2024-11-01"
Maximum string length: 10
Example:

"2024-11-01"

​
If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

​
If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Query Parameters

​
include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Available options:
embedded,
links,
totalCount

Body

application/json

The webhook-endpoint to test.

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.

​
webhookEndpoint
webhook-endpoint-reference · object
required

Reference to a webhook-endpoint resource.

​
id
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<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
​
event
event-reference · object

Reference to an (webhook-)event resource.

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

Response

Accepted

The created webhook-delivery resource.

​
id
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<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
​
event
event-reference · object

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

Reference to a webhook-endpoint resource.

​
links
object
​
embedded
object

Embeds the representation of resources related to the webhook-delivery(ies).

Only returned if requested by the API client: ?include=embedded.