Skip to main content
GET
/
lucca-api
/
webhook-endpoints
List webhook-endpoints
curl --request GET \
  --url https://{host}/lucca-api/webhook-endpoints \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "webhook-endpoints",
  "url": "https://example.ilucca.net/lucca-api/webhook-endpoints?limit=25",
  "totalCount": 12,
  "items": [
    {
      "id": "456789412",
      "type": "webhook-endpoint",
      "url": "https://example.ilucca.net/lucca-api/webhook-endpoints/93847DF7FDSF6D87SF",
      "name": "Test",
      "apiVersion": "2024-11-01",
      "webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
      "topics": [
        "employee.created",
        "employee.updated",
        "employee.deleted"
      ],
      "status": "active",
      "createdAt": "2023-04-23T09:23:54.001Z",
      "lastUpdatedAt": "2023-04-23T09:23:54.001Z",
      "links": {}
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/webhook-endpoints?page=!98438df&limit=25"
    }
  },
  "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.
OAuth 2.0 scopes
 webhook-endpoints.readonly
or
 webhook-endpoints.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

​
status
enum<string>[]

Only return webhook-endpoints that are at one of the given statuses.

Available options:
active,
suspended,
inactive
Example:
["active"]
​
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

Response

OK

A collection of webhook-endpoint resources.

​
type
string
Allowed value: "webhook-endpoints"
​
url
string<uri>
​
totalCount
integer<int64> | null

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

Required range: x >= 0
​
items
webhook-endpoint · object[]

Paginated list of webhook-endpoint resources.

Maximum array length: 100
​
links
Links · object

Links to related resources

​
embedded
object

No embedded resources on a webhook-endpoint(s) response. Expect an empty object if embedded are requested.