Skip to content
Handinger
Get started
API Reference
Workers

Webhooks

Configure outbound webhooks delivered when a worker’s tasks complete.

Retrieve a worker webhook
$ handinger workers:webhooks retrieve
GET/api/workers/{workerId}/webhook
Update a worker webhook
$ handinger workers:webhooks update
PUT/api/workers/{workerId}/webhook
Delete a worker webhook
$ handinger workers:webhooks delete
DELETE/api/workers/{workerId}/webhook
Regenerate a worker webhook token
$ handinger workers:webhooks regenerate-token
POST/api/workers/{workerId}/webhook/regenerate-token
List worker webhook executions
$ handinger workers:webhooks list-executions
GET/api/workers/{workerId}/webhook/executions
ModelsExpand Collapse
update_webhook: object { url }
url: string

HTTPS endpoint Handinger should POST to when a task finishes. Pass null to remove the webhook and clear its token.

webhook: object { token, url }
token: string

Shared secret sent in the X-Handinger-Token header on each delivery. null when no webhook is configured.

url: string

HTTPS endpoint that receives webhook deliveries when a task completes. null when no webhook is configured.

webhook_execution: object { id, createdAt, durationMs, 7 more }
id: string
createdAt: string
durationMs: number

Wall-clock time spent on the delivery attempt.

errorMessage: string

Failure reason when requestStatus is error.

requestStatus: "success" or "error"

success when the endpoint returned a 2xx response, error otherwise.

"success"
"error"
responseStatus: number

HTTP status returned by the endpoint, when reachable.

taskId: string

Task that triggered the delivery, when available.

taskTitle: string

Title of the originating task, when available.

url: string

Endpoint Handinger attempted to deliver to.

workerId: string
webhook_execution_list: object { logs, page, pageCount, totalCount }
logs: array of WebhookExecution { id, createdAt, durationMs, 7 more }
id: string
createdAt: string
durationMs: number

Wall-clock time spent on the delivery attempt.

errorMessage: string

Failure reason when requestStatus is error.

requestStatus: "success" or "error"

success when the endpoint returned a 2xx response, error otherwise.

"success"
"error"
responseStatus: number

HTTP status returned by the endpoint, when reachable.

taskId: string

Task that triggered the delivery, when available.

taskTitle: string

Title of the originating task, when available.

url: string

Endpoint Handinger attempted to deliver to.

workerId: string
page: number

Current page number.

pageCount: number

Total number of pages available.

totalCount: number

Total number of executions recorded.