WaterMinder X-Callback-URL

Updated 04202023-193319

• Gist
• WTF
• Local
• Bear
• Draft

⠀ WaterMinder 3.6 and later for iOS supports x-callback-url, allowing other apps to call certain actions like logging a drink. Below you will find documentation which actions/parameters are available.

URL Scheme

Used scheme is waterminder://

Every action can be called via the x-callback-url API using the following format:

waterminder://x-callback-url/[action]?[parameter]&[parameter]

Any blank space must be replaced with %20

Available Actions

• add-water
• add-caffeine
• add-other
• log-cup

⠀

add-water

This action logs water.

Parameters:

• amount(numeric), positive numeric value
• time(optional), default time it will log water with system current time, however it also supports the following format: dd/MM/yyyy'T'HH:mm - example: 22/01/2019T13:17

⠀ Example: waterminder://x-callback-url/add-water?amount=100

add-caffeine

This action logs caffeine.

Parameters:

• amount(numeric), positive numeric value
• time(optional), default time it will log caffeine with system current time, however it also supports the following format: dd/MM/yyyy'T'HH:mm - example: 09/04/2021T13:17

⠀ Example: waterminder://x-callback-url/add-caffeine?amount=115&time=09/04/2021T13:17

add-other

This action logs drink with specified other drink type.

Parameters:

• amount (numeric), positive numeric value
• type (text), choose drink identifier from list below
• time (optional), default time it will log water with system current time

⠀

Drink Type Identifiers:

• water
• carbonated_water
• coconut_water
• tea
• coffee
• juice
• sports_drink
• energy_drink
• protein_shake
• milk
• skim_milk
• soup
• hot_chocolate
• smoothie
• soda
• beer
• wine
• liquor

⠀ Example: waterminder://x-callback-url/add-other?type=carbonated_water&amount=250

log-cup

This action logs entry using your pre-defined cup name.

Parameters:

• amount (numeric), positive numeric value
• cupName (text), should be a valid cup name which already exists in WaterMinder
• time (optional), default time it will log water with system current time

⠀ Example: waterminder://x-callback-url/add-cup?cupName=my%20mug