Jinba Toolbox
Guides

Webhooks

Setting up event notifications

Overview

Receive HTTP notifications for tool executions and version publishing.

Events

EventDescription
tool.run.completedTool execution succeeded
tool.run.failedTool execution failed
toolset.publishedNew version published

Configuration

  1. Open "Webhooks" in the sidebar
  2. Click "New Webhook"
  3. Set URL and events
  4. Save the displayed secret (used for signature verification)

Payload

{
  "event": "tool.run.completed",
  "timestamp": "2024-01-15T10:00:00.000Z",
  "data": {
    "runId": "run_xxx",
    "toolSetSlug": "my-toolset",
    "toolSlug": "my-tool",
    "status": "success"
  }
}

Signature Verification

Verify signatures using the X-Webhook-Signature header.

import hmac
import hashlib

def verify(payload: str, signature: str, secret: str) -> bool:
    expected = hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest()
    return signature == f"sha256={expected}"

Retries

Failed deliveries are retried up to 3 times (after 1 min, 5 min, 30 min).

HTTP status 200-299 is considered successful.

On this page