GET
/
lucca-api
/
webhook-delivery-attempts
/
{id}
Retrieve a webhook-delivery-attempt
curl --request GET \
  --url https://{host}/lucca-api/webhook-delivery-attempts/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "type": "<string>",
  "url": "<string>",
  "signature": "<string>",
  "webhookDelivery": {
    "id": "<string>",
    "type": "webhook-delivery",
    "url": "<string>"
  },
  "isSuccessful": true,
  "responseStatusCode": 349,
  "errorResponseBody": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "links": null,
  "embedded": {
    "webhook-delivery": {},
    "event": {}
  }
}

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

Path Parameters

​
id
string
required

ID of the webhook-delivery-attempt.

Minimum length: 1

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

200
application/json

OK

A webhook-delivery-attempt is an attempt to send an event to a webhook-endpoint.

For any webhook-delivery, there may be multiple webhook-delivery-attempts, as the webhook service will retry sending an event if the webhook-endpoint fails to respond successfully. Embedded resources on a webhook-delivery-attempt(s) response. A webhook-delivery-attempt resource.