notify

Notify - Subscribe

This service allows to receive notifications from Withings:

  • for the Health Data APIs : your application can subscribe to a variety or events, including user data creation and updates. Notifications will be sent to your servers when the subscribed events occur. (more information). Please note that you need to subscribe for each individual user.
  • for the Logistics APIs: a notification will be sent when there is an order update (more information)
  • for partners integrating Withings Cellular Solutions or Withings Mobile SDK: you can use the NO_ACCOUNT_ASSOCIATED event to track unassociated devices . Please note you need to subscribe only once per application.

Note: depending on your use case, the request parameters may change:

  • for the Health Data APIs: use a valid access_token in the header but don't use signature and nonce in the query parameters.
  • for the Logistics APIs: the subscription is done automatically an order is placed (please refer to the dedicated documentation section)
  • for partners integrating Withings Cellular Solutions or Withings Mobile SDK, to subscribe to the NO_ACCOUNT_ASSOCIATED event (appli = 53): use signature and nonce parameters but don't include an access_token in the header.
posthttps://wbsapi.withings.net/notify

Request

  • Base URL
    https://wbsapi.withings.net
  • Auth
    none declared. Required headers: Authorization

Query parameters

actionstring required

Service action name. Must take the string value subscribe.

callbackurlstring required

Your Callback URL.

appliinteger required

Refer to the Notifications section to know which value you should use.

signaturestring required

DO NOT USE WITH FOLLOWING PARAMS: [access_token]<br>Hash of params (Cf. Signature hash protocol).

noncestring required

DO NOT USE WITH FOLLOWING PARAMS: [access_token]<br>A random token used to prevent replay attacks (Cf. Signature v2 - Getnonce)

client_idstring required

DO NOT USE WITH FOLLOWING PARAMS: [access_token]<br>Id of the client

commentstring

Comment.

Headers

Authorizationstring required

Used to pass your access token. Must take value: Bearer {your access_token} Replace {your access_token} with the access_token

Response

(Click to unfold)

statusinteger

Response status. See <a href='#tag/response_status'>Status</a> section for details.

bodyobject

Response data.

Changes

No recorded changes to this operation across all 1 revision of this API.