GET
/
lucca-api
/
webhook-deliveries
List webhook-deliveries
curl --request GET \
  --url https://{host}/lucca-api/webhook-deliveries \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

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:
TitleConst
2024-11-01
Examples:

"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.

Examples:

"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.

Examples:

"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.

Response

OK

A collection of webhook-delivery objects. Embedded resources on a webhook-delivery(ies) response. Links on a collection. A collection of webhook-delivery resources.

​
type
string
required
Allowed value: "webhook-deliveries"
​
url
string<uri>
required
​
items
webhook-delivery · object[]
required

Paginated list of webhook-delivery resources.

Maximum length: 100
​
totalCount
integer | null

Total number of webhook-delivery resources across all pages that satisfy query parameters.

Required range: x >= 0
​
embedded
object | null
​
links
object | null

Links to related resources