Skip to content

Document the webhook management API - #33

Draft
qayshp wants to merge 3 commits into
BlueBubblesApp:masterfrom
qayshp:agent/document-webhook-api
Draft

Document the webhook management API#33
qayshp wants to merge 3 commits into
BlueBubblesApp:masterfrom
qayshp:agent/document-webhook-api

Conversation

@qayshp

@qayshp qayshp commented Jul 23, 2026

Copy link
Copy Markdown

Summary

  • add a dedicated guide for listing, creating, and deleting webhooks through the REST API
  • include authenticated curl examples and successful response shapes
  • document wildcard subscriptions, unique-URL behavior, and common API errors
  • keep the examples compatible with older macOS curl versions
  • add the guide to the server documentation table of contents

Validation

  • git diff --check origin/master...HEAD passes
  • all three JSON response examples parse successfully
  • every documented route, field, response, and behavior matches the current server router, validator, entity, and repository code
  • the referenced internal documentation links resolve
  • list, single-ID GET, JSON POST, and DELETE requests were exercised against a local receiver with a password containing a space and &; their methods, encoded queries, and POST body were preserved

Notes

  • This documents API endpoints that already exist in the server; it does not change server behavior.
  • PR Document webhook payloads and event keys #32 separately expands the full webhook event-key and payload reference.
  • No authenticated live-server round trip was required for the local command-compatibility check.

Fixes BlueBubblesApp/bluebubbles-server#519

@qayshp qayshp left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review focused on keeping the automation examples usable across supported macOS environments.

Comment thread server/developer-guides/webhook-management-api.md Outdated
@qayshp

qayshp commented Jul 23, 2026

Copy link
Copy Markdown
Author

Validation update

  • Commit 39197da removed the extra blank line that caused the earlier diff-check failure.
  • git diff --check origin/master...HEAD now passes.
  • All three JSON response examples parse successfully.
  • The documented GET, POST, and DELETE routes, response shapes, unique-URL behavior, and error cases match the current router, validator, entity, and repository code.
  • The curl 8.7.1 installed on this Mac supports --url-query.

No authenticated live-server API round trip was performed in this pass. The current-machine curl check also does not establish compatibility with the much older curl versions bundled with the oldest supported macOS releases.

@qayshp

qayshp commented Jul 28, 2026

Copy link
Copy Markdown
Author

Validation supersession: the earlier old-curl limitation was addressed in 6ffc4e1. The examples no longer use --url-query; list, single-ID GET, JSON POST, and DELETE were exercised locally with reserved password characters while preserving methods, encoded queries, and the POST body. Current source comparison plus JSON, link, shell-syntax, and diff checks pass.

@qayshp
qayshp marked this pull request as ready for review July 28, 2026 07:02
@qayshp
qayshp marked this pull request as draft July 28, 2026 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API endpoints for managing webhooks

1 participant