WebhookServer¶
webhook_server
¶
Webhook server for receiving real-time ClickUp events.
This module provides a lightweight HTTP server that receives webhook notifications from ClickUp when tasks are created, updated, or deleted.
Architecture: - Cloud Run receives ClickUp webhooks and stores events - Local clients poll /events endpoint to fetch pending events - Events are stored in memory with optional persistence to file
ClickUpWebhookHandler
¶
Bases: BaseHTTPRequestHandler
HTTP request handler for ClickUp webhooks.
Source code in beads_clickup/webhook_server.py
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | |
do_GET()
¶
Handle GET requests (health check, events API).
Source code in beads_clickup/webhook_server.py
do_POST()
¶
Handle POST requests (webhook events, event acknowledgment).
Source code in beads_clickup/webhook_server.py
WebhookEvent
dataclass
¶
Represents a ClickUp webhook event.
Source code in beads_clickup/webhook_server.py
WebhookEventProcessor
¶
Processes webhook events and triggers sync operations.
Source code in beads_clickup/webhook_server.py
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 | |
__init__(sync_engine, config)
¶
Initialize the event processor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sync_engine
|
Any
|
SyncEngine instance for performing sync operations |
required |
config
|
dict[str, Any]
|
Configuration dictionary |
required |
Source code in beads_clickup/webhook_server.py
process_event(event)
¶
Process a single webhook event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
WebhookEvent
|
WebhookEvent to process |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if processing succeeded, False otherwise |
Source code in beads_clickup/webhook_server.py
WebhookEventQueue
¶
Thread-safe queue for webhook events.
Source code in beads_clickup/webhook_server.py
add_callback(callback)
¶
clear()
¶
peek()
¶
pop()
¶
push(event)
¶
Add an event to the queue.
Source code in beads_clickup/webhook_server.py
WebhookServer
¶
ClickUp webhook server for real-time sync.
Source code in beads_clickup/webhook_server.py
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 | |
__init__(host='0.0.0.0', port=8765, webhook_secret=None, event_filter=None)
¶
Initialize the webhook server.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
host
|
str
|
Host to bind to (default: 0.0.0.0 for all interfaces) |
'0.0.0.0'
|
port
|
int
|
Port to listen on (default: 8765) |
8765
|
webhook_secret
|
str | None
|
Secret for signature verification (optional) |
None
|
event_filter
|
set[str] | None
|
Set of event types to accept (default: all task events) |
None
|
Source code in beads_clickup/webhook_server.py
get_webhook_url(external_host=None)
¶
Get the webhook URL to register with ClickUp.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
external_host
|
str | None
|
External hostname/IP if behind NAT/proxy |
None
|
Returns:
| Type | Description |
|---|---|
str
|
Webhook URL string |
Source code in beads_clickup/webhook_server.py
is_running()
¶
start(background=True)
¶
Start the webhook server.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
background
|
bool
|
If True, run in a background thread |
True
|
Source code in beads_clickup/webhook_server.py
stop()
¶
Stop the webhook server.
Source code in beads_clickup/webhook_server.py
create_webhook_server_from_config(config_path=None)
¶
Create a webhook server from configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config_path
|
str | Path | None
|
Path to config.yaml (optional, uses default if not provided) |
None
|
Returns:
| Type | Description |
|---|---|
WebhookServer
|
Configured WebhookServer instance |