Skip to main content

Native SDK notification

Discussion

Notifications notify you of all major events that have occurred inside the WebView with additional information (error message in case of installation failure, for instance). Each notification below has a "Close WebView" recommendation, which lets you know if this is the right moment to close the WebView on your app. The SDK won't close it for you.

Notifications

Name (type)DescriptionParametersClose WebView
Installation success (1)
  • When: after the successful installation of a device using the Installation Webview
  • UI: device installation confirmation screen
  • device_id
  • device_model_id
  • authorisation_code (optional)
  • external_id (optional)
  • advertise_key (optional)
Yes
Installation failure (2)
  • When: an error has occurred during installation (WI-FI setup for example)
  • UI: error screen with a "Retry" button
  • device_model_id
  • error_code
  • error_message
  • external_id (optional)
No
Account error (3)
  • When: an error has occurred during account creation
  • UI: error screen
  • error_code
  • error_message
Yes
Installation from settings success (4)
  • When: after the successful installation of a device launched from the Device Settings Page
  • UI: device installation screen
  • device_id
  • device_model_id
  • advertise_key (optional)
No
Installation from settings failure (5)
  • When: an error has occurred during an installation launched from the settings page
  • UI: error screen with "retry" button
  • device_model_id
  • error_code
  • error_message
No
Device dissociation success (6)
  • When: after the end user has successfully dissociated a device from the device setting page
  • UI: device settings page
  • device_id
  • device_model_id
  • advertise_key (optional)
No
Device dissociation failure (7)
  • When: an error has occurred when the end user has attempted to dissociate a device from the device setting page
  • UI: device settings page
  • device_id
  • device_model_id
  • error_code
  • error_message
No
Update WI-FI settings success (8)
  • When: after the end user has successfully updated the device's WI-FI configuration from the device setting page
  • UI: device settings page
  • device_id
  • device_model_id
  • advertise_key (optional)
No
Update WI-FI settings failure (9)
  • When: an error has occurred when the end user tried to update the device's WI-FI configuration from the device setting page
  • UI: error screen with "retry" button
  • device_id
  • device_model_id
  • error_code
  • error_message
No
Device synchronisation success (12)
  • When: after the end user has successfully synchronised the device from the device setting page
  • UI: device settings page
  • device_id
  • device_model_id
  • advertise_key (optional)
No
Device synchronisation failure (13)
  • When: an error has occurred when the end user tried to synchronise the device from the device setting page
  • UI: device settings page with an error state
  • device_id
  • device_model_id
  • error_code
  • error_message
No
Link out (16)
  • When: the end user clicks on a Withings Help Centre web link. The SDK opens the native browser.
  • UI: device settings page
  • url
No
Settings error (17)
  • When: an error has occurred in the settigns webview
  • UI: the error will appear in the snackbar at the top of the settings webview.
  • error_code
  • error_message
No
Help

Login required

Please log in to your Developer Dashboard in order to file a request.

OK