Skip to content

Document webhook id field and Idempotency-Key deduplication#195

Merged
kamil-lucyszyn-tedee merged 1 commit into
masterfrom
feature/webhooks-docs-improved
Jul 8, 2026
Merged

Document webhook id field and Idempotency-Key deduplication#195
kamil-lucyszyn-tedee merged 1 commit into
masterfrom
feature/webhooks-docs-improved

Conversation

@kamil-lucyszyn-tedee

@kamil-lucyszyn-tedee kamil-lucyszyn-tedee commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add the id field (unique per webhook, used for deduplication) to the Body table and JSON examples of all five webhook event docs
  • Document the Idempotency-Key HTTP header and deduplication behavior in the webhooks overview page

Test plan

  • sphinx-build -b html completes with no warnings/errors
  • Verified RST grid table column widths/alignment render correctly

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the webhook documentation to describe deduplication semantics by documenting the per-delivery webhook id field and the corresponding Idempotency-Key request header, and adds the id field to all webhook event payload docs.

Changes:

  • Added a “Deduplication” section to the webhooks overview, documenting id and Idempotency-Key behavior on retries.
  • Added the id field to the Body tables and JSON examples for all five webhook event pages.
  • Minor formatting cleanup in the overview example paragraph.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/source/webhooks/overview.rst Documents webhook delivery deduplication using id / Idempotency-Key.
docs/source/webhooks/lock-status-changed.rst Adds id to the payload schema and example.
docs/source/webhooks/device-settings-changed.rst Adds id to the payload schema and example.
docs/source/webhooks/device-connection-changed.rst Adds id to the payload schema and example.
docs/source/webhooks/device-battery-level-changed.rst Adds id to the payload schema and example.
docs/source/webhooks/bell-button-pressed.rst Adds id to the payload schema and example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/source/webhooks/bell-button-pressed.rst
@kamil-lucyszyn-tedee
kamil-lucyszyn-tedee merged commit 2a05280 into master Jul 8, 2026
2 checks passed
@kamil-lucyszyn-tedee
kamil-lucyszyn-tedee deleted the feature/webhooks-docs-improved branch July 8, 2026 14:27
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.

3 participants