Skip to content
Get started

Update a worker webhook

workers.webhooks.update(worker_id, **kwargs) -> Webhook { token, url }
PUT/api/workers/{workerId}/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.

ParametersExpand Collapse
worker_id: String
url: String

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

maxLength2048
formaturi
ReturnsExpand Collapse
class Webhook { 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.

Update a worker webhook

require "handinger"

handinger = Handinger::Client.new(api_key: "My API Key")

webhook = handinger.workers.webhooks.update(
  "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
  url: "https://example.com/handinger-webhook"
)

puts(webhook)
{
  "token": "whk_01HZY31W2SZJ8MJ2FQTR3M1K9D",
  "url": "https://example.com/handinger-webhook"
}
Returns Examples
{
  "token": "whk_01HZY31W2SZJ8MJ2FQTR3M1K9D",
  "url": "https://example.com/handinger-webhook"
}