Skip to content
Get started

Retrieve a worker webhook

workers.webhooks.retrieve(strworker_id) -> Webhook
GET/api/workers/{workerId}/webhook

Retrieve the webhook URL and shared token configured for a worker. Both fields are null when no webhook is configured. Only the worker creator can read the webhook configuration.

ParametersExpand Collapse
worker_id: str
ReturnsExpand Collapse
class Webhook:
token: Optional[str]

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

url: Optional[str]

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

Retrieve a worker webhook

import os
from handinger import Handinger

client = Handinger(
    api_key=os.environ.get("HANDINGER_API_KEY"),  # This is the default and can be omitted
)
webhook = client.workers.webhooks.retrieve(
    "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
)
print(webhook.token)
{
  "token": "whk_01HZY31W2SZJ8MJ2FQTR3M1K9D",
  "url": "https://example.com/handinger-webhook"
}
Returns Examples
{
  "token": "whk_01HZY31W2SZJ8MJ2FQTR3M1K9D",
  "url": "https://example.com/handinger-webhook"
}