Withings API icon

Withings API

Withings API Integration
Join our community

Actions11

Overview

This node integrates with the Withings API to retrieve various user-related health and activity data. Specifically, for the User resource with the Get Goals operation, it fetches the user's health goals set within the Withings ecosystem. This can be useful for scenarios where you want to monitor or analyze a user's fitness targets, such as weight loss goals, step count targets, or other personalized health objectives.

Practical examples include:

  • Automatically fetching user goals to display in a custom dashboard.
  • Triggering workflows when certain goals are reached or updated.
  • Combining goal data with actual activity or measurement data for progress tracking.

Properties

Name Meaning
Additional Fields Optional parameters to refine data retrieval:
- Start Date: Start date for data retrieval (timestamp).
- End Date: End date for data retrieval (timestamp).
- Last Update: Retrieve only data updated after this date (timestamp).
- Offset: Skip this many records (for pagination).

Output

The node outputs JSON data containing the response from the Withings API related to the user's goals. The output structure includes:

  • success: Boolean indicating if the request was successful.
  • resource: The resource type, here always "user".
  • operation: The operation performed, here "getgoals".
  • Other fields as returned by the Withings API under the body property, which typically contains detailed information about the user's goals.

If the API call fails, the output will contain an error message and status details unless the node is configured to continue on failure.

No binary data is output by this operation.

Dependencies

  • Requires an OAuth2 API credential for authenticating with the Withings API.
  • The node makes HTTP GET requests to the Withings API endpoints.
  • Proper configuration of the OAuth2 credentials with required scopes is necessary.
  • Network connectivity to https://wbsapi.withings.net is required.

Troubleshooting

  • Authentication Errors: Common errors include invalid or expired tokens, unauthorized access, or insufficient permissions. Resolution steps:
    1. Reconnect or refresh the OAuth2 credentials.
    2. Verify that the Withings developer account and application have the correct scopes enabled.
    3. Ensure the Withings user account is active and properly linked.
  • API Rate Limits or Temporary Failures: The node implements retries with exponential backoff. If failures persist, check Withings API status or reduce request frequency.
  • Invalid Date Formats: Ensure that date inputs for additional fields are valid ISO date strings or timestamps.
  • Pagination Issues: Use the Offset field to paginate through large result sets.

Links and References

Discussion