v27

latestOpenAPI 3.1.0LicenseRef-Proprietaryraw.githubusercontent.com2026-07-21173076.1 KB
Webhooks

Update a worker webhook

Set or replace the webhook URL for a worker. A fresh token is generated the first time a URL is set; subsequent updates keep the existing token. Pass url: null to clear the webhook (use the dedicated DELETE for the same effect). Only the worker creator can update the webhook.

put/api/workers/{workerId}/webhook

Path parameters

workerIdstring required
Example:t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM

Worker id returned by the create worker endpoint.

Request body

urlstring uri nullable required

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

Example request

{
  "url": "https://example.com/handinger-webhook"
}

Response

Updated webhook configuration.

urlstring nullable required

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

tokenstring nullable required

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

Example response

{
  "url": "https://example.com/handinger-webhook",
  "token": "whk_01HZY31W2SZJ8MJ2FQTR3M1K9D"
}