Documentation

NodePing Branding

Branding allows you to customize the text of notifications and other messages that users will receive from the monitoring service. This means that you can put your own company name and information on the messages your customers will receive when monitoring events occur. Your branding customizations are applied across all of your subaccounts.

Notification Message Branding

Branding is managed under Account Settings / Branding. You can customize the full text of each message using plain text (HTML is not supported) for email notifications. You can also set the "From" address and Subject of the messages. For SMS notifications, you can customize the text of the message. The message branding features use a template system, so you have full control over the contents of the messages to your customers.

Notification Branding Templates

The branding templates use a curly braces syntax for setting the fields within the text. The supported fields include:

  • _id - The check id (example: 201703291232FQS0Y-F27DXDJ4)
  • checktime - time at which the check was run.
  • description - description field
  • downtime - how many minutes the check was "down." This variable is generally available for "Up" report (triggered when a site or service was down but has changed to being up), but it is not guaranteed to be available for all "Up" events. The most common situation in which it is not available is when the time span that the service was down is very long (more than a day). You should check for downtime before depending on it being present.
  • interval - interval setting for the check.
  • label - the check's label. If the user did not assign a label, this variable will have something appropriate to the check type, most often the URL or target address.
  • location - list of locations in which the result was verified
  • message - only available for 'down' events. Error message from down event - may give clue to the reason for the down event.
  • password - only available for welcome and password change messages.
  • publicreporturl - URL for the public report, if it is available.
  • target - URL or Host being monitored
  • threshold - check timeout setting
  • type - check type

The variables are included by placing them in the text of the message surrounded by curly braces. For example, to include the time that a service went down, you might include text like this:

This check is down as of {checktime}.

The template system also allows conditional statements, so you can include some information only if it is available. For example, publicreporturl is only available in the Public Reports feature is enabled for the specific check. So if you want the Public report URL to appear in the message if it is available, you might include something like the following:

{if publicreporturl}The public report is available at {publicreporturl}.{/if}

If statements only check for whether a supported variable is true or false. Conditional statements can also include {if not variable} and {else}.

If you have any questions, get in touch at support@nodeping.com, or use our Contact form.