API reference
Webhooks
11 endpoints. Click one to see its parameters, fields and an example. Code samples use the region you pick.
GET/v1/webhook-deliveriesList webhook deliveries
List webhook deliveries
Query parameters
| Name | Type | Description |
|---|---|---|
endpoint_id | string | |
status | "pending" | "retrying" | "success" | "failed" | |
limit | integer | Default 100 |
cursor | string |
Example
curl "https://ca-api.clocklap.com/v1/webhook-deliveries" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
GET/v1/webhook-deliveries/{id}One delivery: the exact request sent and every attempt with its response
One delivery: the exact request sent and every attempt with its response
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl "https://ca-api.clocklap.com/v1/webhook-deliveries/{id}" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/webhook-deliveries/{id}/retryRetry
Retry
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl -X POST "https://ca-api.clocklap.com/v1/webhook-deliveries/{id}/retry" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
GET/v1/webhook-endpointsList webhook endpoints
List webhook endpoints
Example
curl "https://ca-api.clocklap.com/v1/webhook-endpoints" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/webhook-endpointsSubscribe a URL to events ("*" for all). The signing secret is returned once.
Subscribe a URL to events ("*" for all). The signing secret is returned once.
Body (JSON)
| Name | Type | Description |
|---|---|---|
urlrequired | string (uri) | |
description | string | |
event_typesrequired | array of string | |
location_id | string or null | |
payload | "full" | "thin" | Default "full" |
active | boolean |
Example
curl -X POST "https://ca-api.clocklap.com/v1/webhook-endpoints" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/clocklap-webhook","event_types":["string"]}'Responses
200
PATCH/v1/webhook-endpoints/{id}Update one webhook endpoint
Update one webhook endpoint
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Body (JSON)
| Name | Type | Description |
|---|---|---|
url | string (uri) | |
description | string | |
event_types | array of string | |
location_id | string or null | |
payload | "full" | "thin" | |
active | boolean |
Example
curl -X PATCH "https://ca-api.clocklap.com/v1/webhook-endpoints/{id}" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Responses
200
DELETE/v1/webhook-endpoints/{id}Delete one webhook endpoint
Delete one webhook endpoint
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl -X DELETE "https://ca-api.clocklap.com/v1/webhook-endpoints/{id}" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/webhook-endpoints/{id}/reenableTurn a switched-off endpoint back on, optionally resending what it missed (max 30 days)
Turn a switched-off endpoint back on, optionally resending what it missed (max 30 days)
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Body (JSON)
| Name | Type | Description |
|---|---|---|
resend | boolean | Default true |
Example
curl -X POST "https://ca-api.clocklap.com/v1/webhook-endpoints/{id}/reenable" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"resend":true}'Responses
200
POST/v1/webhook-endpoints/{id}/replayRe-send events from a time window (max 30 days back)
Re-send events from a time window (max 30 days back)
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Body (JSON)
| Name | Type | Description |
|---|---|---|
sincerequired | string (date-time) | |
until | string (date-time) |
Example
curl -X POST "https://ca-api.clocklap.com/v1/webhook-endpoints/{id}/replay" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"since":"2026-10-26T13:00:00Z","until":"2026-10-26T13:00:00Z"}'Responses
200
POST/v1/webhook-endpoints/{id}/rotate-secretNew secret; the old one also signs for 24 h
New secret; the old one also signs for 24 h
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl -X POST "https://ca-api.clocklap.com/v1/webhook-endpoints/{id}/rotate-secret" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/webhook-endpoints/{id}/testSend a signed webhook.test event now
Send a signed webhook.test event now
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl -X POST "https://ca-api.clocklap.com/v1/webhook-endpoints/{id}/test" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200