Event Notification Settings
Set up email notifications for specific events within the app using your own email server or through a Zapier webhook.
For security reasons, we recommend setting up a separate email account to send these alerts rather than using your primary email address. You need to use a valid, working email address, but you can set up a single email account and use it for multiple iPads. Since the email subject line always includes the Unique iPad ID from Kiosk Pro settings (if it is set), you can differentiate which kiosk is having an issue in that way without setting up multiple email addresses.
In this article
- Power Supply Change Notification
- Battery Level Change Notification
- Remote Update of Settings Notification
- Remote Update of Local Files Notification
- Accelerometer Motion Detection Notification
- Switch between Cellular Data & WiFi Notification
- Send Event Notifications Through
- SMTP Email Server
- Zapier Webhook URL
Power Supply Change Notification
Supported in:
Receive email notifications when the power status changes.
Default Value: Off
This can be a useful tool for notifications if the iPad loses external power due to a system-wide power outage, a blown breaker, a pulled plug or theft. This feature will also send a notification when external power is restored.
This setting can only be used in conjunction with the SMTP Email Server settings which must be set up for email to be sent.
Values for Remote Settings Control & Managed App Configuration
| Key | emailOnPower |
|---|---|
| Key Type | boolean |
| Default Value | false |
Battery Level Change Notification
Supported in:
Receive email notifications when the battery level changes. You can control when you want to receive an email notification by setting different zones.
Default Values:
- Off or Undefined
Kiosk Pro uses three different charging zones:
- Normal Zone - ranges from 100% to the percentage you set for the Low %.
- Low Zone - ranges from the Low % to the percentage you set for the Critical %.
- Critical Zone - ranges from the Critical % to 0%.
You can choose whether to receive an email notification when the battery level enters a zone, either from Discharging or Charging, by enabling the appropriate toggle switches.
You can create two zones instead of three by setting only one of the percentages. The Normal Zone will then range from 100% to whichever percentage you set, and the Low/Critical Zone will be from the percentage you set to 0%. In this case, Kiosk Pro will use the email toggles in the zone with the set percentage.
You can also choose to receive an email notification for each zone when the iPad is charging or when the iPad is unplugged.
This setting can only be used in conjunction with the SMTP Email Server settings which must be set up for email to be sent.
Example
With the following values set, if you have Battery Discharge to Lower Zone turned On, you will receive an email when the battery reaches 50% while discharging, and again when it reaches 20%:
- Low % = 50%
- Critical % = 20%
Values for Remote Settings Control & Managed App Configuration
| Battery Discharge to Lower Zone | |
|---|---|
| Key | emailOnBatteryDischargeToLowerZone |
| Key Type | boolean |
| Default Value | false |
| Battery Charge to Higher Zone | |
| Key | emailOnBatteryChargeToHigherZone |
| Key Type | boolean |
| Default Value | false |
| Low % | |
| Key | lowZoneLevel |
| Key Type | integer |
| Default Value | -1 |
| Possible Values |
|
| Notify when Unplugged in Normal Zone | |
| Key | emailWhenUnpluggedInNormalZone |
| Key Type | boolean |
| Default Value | false |
| Notify when Charging in Normal Zone | |
| Key | emailWhenChargingInNormalZone |
| Key Type | boolean |
| Default Value | false |
| Critical % | |
| Key | criticalZoneLevel |
| Key Type | integer |
| Default Value | -1 |
| Possible Values |
|
| Notify when Unplugged in Low Zone | |
| Key | emailWhenUnpluggedInLowZone |
| Key Type | boolean |
| Default Value | false |
| Notify when Charging in Low Zone | |
| Key | emailWhenChargingInLowZone |
| Key Type | boolean |
| Default Value | false |
| Notify when Unplugged in Critical Zone | |
| Key | emailWhenUnpluggedInCriticalZone |
| Key Type | boolean |
| Default Value | false |
| Notify when Charging in Critical Zone | |
| Key | emailWhenChargingInCriticalZone |
| Key Type | boolean |
| Default Value | false |
Remote Update of Settings Notification
Supported in:
Receive email notifications when the settings are successfully updated remotely using the Remote Settings Control feature.
Default Value: Off
This allows you to confirm that settings were updated correctly when immediate access to the physical kiosk is not available.
This setting can only be used in conjunction with the SMTP Email Server settings which must be set up for email to be sent.
Values for Remote Settings Control & Managed App Configuration
| Key | emailOnRemoteSettingsChange |
|---|---|
| Key Type | boolean |
| Default Value | false |
Remote Update of Local Files Notification
Supported in:
Receive email notifications when the kiosk successfully downloads new local content.
Default Value: Off
This setting allows you to confirm when a remote update of local files occurs successfully. The email generated will be tagged with the Unique iPad ID of the kiosk and includes a list on the files that have been added to the kiosk.
This setting can only be used in conjunction with the SMTP Email Server settings which must be set up for email to be sent.
Values for Remote Settings Control & Managed App Configuration
| Key | emailOnContentUpdate |
|---|---|
| Key Type | boolean |
| Default Value | false |
Accelerometer Motion Detection Notification
Supported in:
Receive email notifications when the iPad's accelerometer detects the iPad has been moved.
Default Value: Off
The email generated will be tagged with the Unique iPad ID of the kiosk sending the notification and the local timestamp of the iPad itself.
Values for Remote Settings Control & Managed App Configuration
| Key | emailOnAccelTrigger |
|---|---|
| Key Type | boolean |
| Default Value | false |
Switch between Cellular Data & WiFi Notification
Supported in:
Receive email notifications when the iPad switches between using cellular data and WiFi. This makes it easier to avoid expensive data plan overages.
Default: Off
The email generated will be tagged with the Unique iPad ID of the kiosk sending the notification, the local timestamp of the iPad itself, and the name of the network the iPad is currently connected to.
Notifications are not sent for WiFi-only devices or devices with cellular data disabled - as these emails are generated by the app itself, there is no way to trigger an email while the device is offline and the notification would only be possible to send when the issue had been already been resolved with the device being reconnected to the internet. If you need a notification of offline status, we recommend looking at our Remote Management Server subscription, which can trigger notifications based on missed heartbeats from the app.
Values for Remote Settings Control & Managed App Configuration
| Key | emailOnChangeNetworkReachabilityStatus |
|---|---|
| Key Type | boolean |
| Default Value | false |
Send Event Notifications Through
Supported in:
Event notifications can be sent using your own email server or Zapier, a service that connects many popular web apps, including Gmail, Twitter, and Slack.
Default Value:
- SMTP Email Server
Other Possible Values:
- Zapier Webhook
Values for Remote Settings Control & Managed App Configuration
| Key | kp_sendEventNotificationsThrough |
|---|---|
| Key Type | integer |
| Default Value | 0 |
| Possible Values |
|
SMTP Email Server
Supported in:
Connect to your SMTP server to send email notifications about the status of your kiosk. We recommend setting up an email address specifically for this purpose, rather than using your primary email account.
From Email
A valid and properly formatted email address capable of generating new email via SMTP.
Default Value: blank
This email will be the account referenced in all of the SMTP settings (excluding To Email) and will appear as the email account the notifications are sent from.
Example: ipad@example.com
Values for Remote Settings Control & Managed App Configuration
| Key | smtpFromEmail |
|---|---|
| Key Type | string |
| Default Value | (blank) |
To Email
A valid and properly formatted email address. This is the account that will receive the notification emails.
Default Value: blank
This setting only supports a single email address. If you want to send alerts to multiple addresses, you'll need to set up automatic forwarding from the email address used here to the other email addresses.
Example: tech@example.com
Values for Remote Settings Control & Managed App Configuration
| Key | smtpToEmail |
|---|---|
| Key Type | string |
| Default Value | (blank) |
SMTP Server
An IP or web address assigned by the email host/provider.
Default Value: blank
Example: smtpout.secureserver.net
Values for Remote Settings Control & Managed App Configuration
| Key | smtpServer |
|---|---|
| Key Type | string |
| Default Value | (blank) |
SMTP Ports
The SMTP ports used to communicate. You should not change this setting from the default unless it is necessary.
Default Value: 25; 465; 587
When Kiosk Pro tries to send a message, it attempts to send through the first port listed. If for some reason the initial port is not open, the app will try to send through the next port in the list and so on.
Values for Remote Settings Control & Managed App Configuration
| Key | smtpPorts |
|---|---|
| Key Type | string |
| Default Value | 25; 465; 587 |
Requires Authentication
This toggles the authenticity requirement. If your mail server does not require a username and password to send mail, you can turn this Off.
Default Value: On
Values for Remote Settings Control & Managed App Configuration
| Key | smtpRequiresAuth |
|---|---|
| Key Type | boolean |
| Default Value | true |
Username
Refers to the account sending the email. This information is given by your email host/provider.
Default Value: blank
Example: The Username for ipad@example.com is ipad.
Values for Remote Settings Control & Managed App Configuration
| Key | smtpUserName |
|---|---|
| Key Type | string |
| Default Value | (blank) |
Password
Refers to the password of the account sending the email.
Default Value: blank
Values for Remote Settings Control & Managed App Configuration
| Key | smtpPassword |
|---|---|
| Key Type | string |
| Default Value | (blank) |
Note: As passwords are considered sensitive information, they are not included in a Remote Settings or Managed App Configuration export from within the app. As such, this setting must be manually added to the file if needed using the following formats:
Remote Settings Control (current V2 XML format) & Managed App Configuration
<key>smtpPassword</key> <string>ENTER PASSWORD HERE</string> (this would be inserted alongside other settings in between an opening <dict> and closing </dict> tag within the file)
Remote Settings Control (legacy XML format)
<dict> <key>Key</key><string>smtpPassword</string> <key>Value</key><string>ENTER PASSWORD HERE</string> </dict><br>
Enable SSL
This setting provides an extra layer of security while sending your email.
Default Value: Off
Values for Remote Settings Control & Managed App Configuration
| Key | smtpEnableSSL |
|---|---|
| Key Type | boolean |
| Default Value | false |
Test
Send a test email to check and see if your settings are correct and the app is able to successfully send email on your behalf. If there is a problem, the app attempts to return information that may be helpful in troubleshooting as follows:
| Code | Description | Suggestion |
|---|---|---|
| - | Timeout sending message. | Sending email requires a connection to the internet - please check your internet connection. If you are connected to the internet and are still seeing this error, your email server may be down - please try sending your message again later. |
| -4 | The connection to the server was interrupted. | Sending email requires a connection to the internet - please check your internet connection. If you are connected to the internet and are still seeing this error, your email server may be down - please try sending your message again later. |
| -3 | Unable to connect to the server. | Sending email requires a connection to the internet - please check your internet connection. If you are connected to the internet and are still seeing this error, your email server may be down or there could be an issue with your server's security certificates - please try sending your message again later. |
| -2 | Unsupported login mechanism. | Your server's security setup is not supported, please contact your system administrator or use a supported email account like MobileMe. |
| 1 | Error resolving host. | Check your SMTP Host name |
| 530 | Relay rejected. | Your server probably requires a username and password. |
| 535 | Invalid username or password. | Go to Email Preferences in the application and re-enter your username and password. |
| 550 | To address rejected. | Please re-enter the To: address. |
| 555 | General error that returns "Failed to send email." | This is a non-specific error returned by the SMTP server. If this is returned, you may want to do additional testing of your SMTP configuration using https://www.smtper.net (free). You might also get in touch with the team running your SMTP server to see if they have any other specific suggestions. |
The above errors are generated by the SMTP library we use to send email. While much more rare, an error can also be generated directly by the iPadOS/iOS operating system (NSOSStatusErrorDomain) - this means that you may see other errors without descriptions or suggestions provided.
Zapier Webhook URL
Supported in:
To create a Zapier Webhook URL, you’ll need to purchase a paid plan from Zapier.com.
Default Value: blank
Zapier has a guide for creating a webhook URL available here. When choosing an event, make sure to choose "Catch Hook".
While setting up the zap in Zapier, you'll need to send data from Kiosk Pro to Zapier to verify that it's working. To do this:
- Open Kiosk Pro’s settings and enter your webhook URL in the Zapier Webhook URL setting.
- Set Enable Event Notifications > Power Supply Change = On.
- Set Send Event Notifications Through = Zapier Webhook.
- Run the kiosk presentation.
- Connect and/or disconnect your device from a power source to trigger the event notification.
- Return to your Zapier editor and test the webhook.
- Once the webhook is verified, you can set up an action to be triggered in a web app when an event notification is sent.
Values for Remote Settings Control & Managed App Configuration
| Key | kp_zapierDefaultZapURL |
|---|---|
| Key Type | string |
| Default Value | (blank) |
Change Log
Included in version 1.0. Notification for successful remote update of local files added in version 1.2. Sending a test email for SMTP connection added in version 3.3. Notification for battery level changes and accelerometer motion added in version 5.0. Notification for switch between cellular data and WiFi added in version 7.6. Notifications through a Zapier webhook added in version 7.7.