API Reference

Workers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

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

Retrieve a worker webhook

GET/api/workers/{workerId}/webhook

Update a worker webhook

PUT/api/workers/{workerId}/webhook

Delete a worker webhook

DELETE/api/workers/{workerId}/webhook

Regenerate a worker webhook token

POST/api/workers/{workerId}/webhook/regenerate-token

List worker webhook executions

GET/api/workers/{workerId}/webhook/executions

ModelsExpand Collapse

UpdateWebhook object { url }

url: string

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

maxLength2048

formaturi

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.

WebhookExecution object { id, createdAt, durationMs, 7 more }

id: string

createdAt: string

formatdate-time

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.

One of the following:

"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

WebhookExecutionList object { logs, page, pageCount, totalCount }

logs: array of WebhookExecution { id, createdAt, durationMs, 7 more }

id: string

createdAt: string

formatdate-time

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.

One of the following:

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