Skip to content

Add more docs to Withings webhook log #158748

Merged
joostlek merged 1 commit into
home-assistant:devfrom
ptarjan:claude/fix-withings-logging-01RmWh2VYEasnULZ43fvbg5R
Dec 18, 2025
Merged

Add more docs to Withings webhook log #158748
joostlek merged 1 commit into
home-assistant:devfrom
ptarjan:claude/fix-withings-logging-01RmWh2VYEasnULZ43fvbg5R

Conversation

@ptarjan
Copy link
Copy Markdown
Contributor

@ptarjan ptarjan commented Dec 11, 2025 •
edited
Loading

It is unclear currently in the logs what to do. Hopefully this helps others.

Breaking change

Proposed change

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@ptarjan ptarjan requested a review from joostlek as a code owner December 11, 2025 21:10
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Dec 11, 2025

Hey there @joostlek, mind taking a look at this pull request as it has been labeled with an integration (withings) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of withings can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign withings Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@ptarjan ptarjan force-pushed the claude/fix-withings-logging-01RmWh2VYEasnULZ43fvbg5R branch 3 times, most recently from ed4c074 to 10b7ffb Compare December 11, 2025 21:26
@ptarjan ptarjan changed the title Change Withings webhook log from warning to debug Fix: Change Withings webhook log from warning to debug Dec 11, 2025
@ptarjan
Copy link
Copy Markdown
Contributor Author

ptarjan commented Dec 11, 2025

I forgot to check the bugfix box when creating this PR. Could a maintainer please add the bugfix label?

@dcmeglio
Copy link
Copy Markdown
Contributor

dcmeglio commented Dec 12, 2025 

The integration continues to function normally via polling
Webhooks are an optimization (real-time updates) not a requirement

The in bed sleep sensor does not fall back to polling, it's webhooks or nothing.

@ptarjan
Copy link
Copy Markdown
Contributor Author

ptarjan commented Dec 12, 2025

My body scale is working without the webhooks. Should we bifricate the log message to only complain for certain devices?

@joostlek
Copy link
Copy Markdown
Member

joostlek commented Dec 12, 2025

Hmm, I kinda think it requires user attention. This would be the only way to find out that it's not correct, so I don't really want to hide it behind it a different log level

@ptarjan
Copy link
Copy Markdown
Contributor Author

ptarjan commented Dec 12, 2025

Hmm, I kinda think it requires user attention. This would be the only way to find out that it's not correct, so I don't really want to hide it behind it a different log level

Ok, do you have any ideas of how to make this more actionable? In my case, I have no idea what I need to do. Is there some config wrong in my withings app? Does my home assistant need some more ports forwarded to it? Does my HA need HTTPS for its main :8123 access?

@joostlek
Copy link
Copy Markdown
Member

joostlek commented Dec 12, 2025

I guess we could do instead with better docs and a link to the docs here. In this case you need to have a HTTPS endpoint, on port 443 (so not HTTPS on a different port)

@ptarjan ptarjan force-pushed the claude/fix-withings-logging-01RmWh2VYEasnULZ43fvbg5R branch 2 times, most recently from c4ba728 to 7aba9f0 Compare December 12, 2025 15:35
@ptarjan ptarjan changed the title Fix: Change Withings webhook log from warning to debug Add more docs to Withings webhook log Dec 12, 2025
@ptarjan ptarjan force-pushed the claude/fix-withings-logging-01RmWh2VYEasnULZ43fvbg5R branch from 7aba9f0 to a74061f Compare December 12, 2025 15:36
@joostlek
Copy link
Copy Markdown
Member

joostlek commented Dec 12, 2025

I mean more like, first update the docs, I believe there would be a section about webhooks, and if there is not we can create one

ptarjan pushed a commit to ptarjan/home-assistant.io that referenced this pull request Dec 12, 2025
@claude
Add Withings integration documentation with webhook requirements
bcc1fb5 
Document that webhooks require HTTPS specifically on port 443, not just
any HTTPS port. This addresses a common configuration issue where users
have HTTPS but on a non-standard port (e.g., 8443).

Also documents that sleep sensors require working webhooks and have no
polling fallback, helping users understand why these sensors may be
missing.

Ref: home-assistant/core#158748
ptarjan added a commit to ptarjan/home-assistant.io that referenced this pull request Dec 12, 2025
@ptarjan @claude
Add Withings integration documentation with webhook requirements
88cac97 
Document that webhooks require HTTPS specifically on port 443, not just
any HTTPS port. This addresses a common configuration issue where users
have HTTPS but on a non-standard port (e.g., 8443).

Also documents that sleep sensors require working webhooks and have no
polling fallback, helping users understand why these sensors may be
missing.

Ref: home-assistant/core#158748
ptarjan added a commit to ptarjan/home-assistant.io that referenced this pull request Dec 12, 2025
@ptarjan @claude
Add webhook requirements section to Withings documentation
4d0da47 
Document that webhooks require HTTPS specifically on port 443, not just
any HTTPS port. This addresses a common configuration issue where users
have HTTPS but on a non-standard port (e.g., 8443).

Also documents that sleep sensors require working webhooks and have no
polling fallback, helping users understand why these sensors may be
missing.

Ref: home-assistant/core#158748
ptarjan added a commit to ptarjan/home-assistant.io that referenced this pull request Dec 12, 2025
@ptarjan @claude
Add webhook requirements section to Withings documentation
576f847 
Document that webhooks require HTTPS specifically on port 443, not just
any HTTPS port. This addresses a common configuration issue where users
have HTTPS but on a non-standard port (e.g., 8443).

Also documents that sleep sensors require working webhooks and have no
polling fallback, helping users understand why these sensors may be
missing.

Ref: home-assistant/core#158748
@ptarjan ptarjan mentioned this pull request Dec 12, 2025
Merged
8 tasks
@ptarjan
Copy link
Copy Markdown
Contributor Author

ptarjan commented Dec 12, 2025

Added to the docs here: #158748

joostlek
joostlek requested changes Dec 16, 2025
View reviewed changes
Comment thread homeassistant/components/withings/__init__.py Outdated
@home-assistant home-assistant Bot marked this pull request as draft December 16, 2025 15:24
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Dec 16, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@ptarjan @claude
Improve Withings webhook error messages with docs link
572b1ff 
Split the webhook registration error into two specific messages:
- One for missing HTTPS
- One for wrong port (not 443)

This helps users understand exactly what needs to be fixed.
Both messages include a link to the integration documentation.
@ptarjan ptarjan force-pushed the claude/fix-withings-logging-01RmWh2VYEasnULZ43fvbg5R branch from a74061f to 572b1ff Compare December 17, 2025 06:51
@ptarjan ptarjan marked this pull request as ready for review December 17, 2025 06:53
@home-assistant home-assistant Bot requested a review from joostlek December 17, 2025 06:54
@joostlek joostlek merged commit e01df6d into home-assistant:dev Dec 18, 2025
36 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@joostlek joostlek joostlek approved these changes

Assignees

@joostlek joostlek

Labels

cla-signed code-quality integration: withings Quality Scale: No score small-pr PRs with less than 30 lines.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ptarjan @dcmeglio @joostlek