Notifications

1. A new destination can be configured when adding a notification rule in the Monitors section inside a workspace, or under Settings > Notifications

2. Destination Name:

   Enter a name for your destination. This helps you to identify this destination in the list of your destinations.

3. Email addresses:
   Enter one or more email addresses. Multiple email addresses are supported, but we recommend the use of distribution/mailing lists instead of trying to add many addresses and keep them up to date with organization changes.

1. A new destination can be configured when adding a notification rule in the Monitors section inside a workspace, or under Settings > Notifications

2. Destination Name:

   Enter a name for your destination. This helps you to identify this destination in the list of your destinations.

3. Username:
   Enter your ServiceNow username.
4. Password:
   Enter your ServiceNow password.
5. URL:
   Enter the URL of your ServiceNow instance.

6. Test:

   Use the Test button to send a test notification and check that it is working as expected.

1. You will need to create a Slack app. Go to https://api.slack.com/apps and click on Create New App.

2. Choose From scratch, specify a name for the app and the Slack workspace that hosts the Slack channels you want to send notifications to.

3. Configure the app icon and description. You can use whatever name, description and icon you would like, but it makes sense for them to refer to SquaredUp so that users can clearly see where the notifications are originating from.

4. Select Add features and functionality and then choose the Permissions option.
5. Configure the chat:write permission to Send messages as @squaredup_alerts.
6. Configure the chat:write.public permission to Send messages to channels.
7. Click Install to Workspace.
8. You should now be given a token.

Now use the token to configure the destination in SquaredUp:

1. A new destination can be configured when adding a notification rule in the Monitors section inside a workspace, or under Settings > Notifications

2. Destination Name:

   Enter a name for your destination. This helps you to identify this destination in the list of your destinations.

3. Token:
   Paste the API token in here.

   You can use the same token to configure multiple SquaredUp destinations, each targeting a different Slack channel.

4. Slack channel:
   Enter the destination Slack channel for messages to be delivered to.

   You can specify public or private Slack channels, but for private channels the Slack app you created must be added to the Slack channel (type /invite in the Slack channel).

5. Test:

   Use the Test button to send a test notification and check that it is working as expected.

   In Slack, when you click the View button in the notification you may get a warning triangle beside it. To fix this, add https://api.squaredup.com/api/slack_interaction as the Interaction URL.

1. You will need to create a Slack app. Go to https://api.slack.com/apps and click on Create New App.

2. Choose From scratch, specify a name for the app and the Slack workspace that hosts the Slack channels you want to send notifications to.

3. Configure the app icon and description. You can use whatever name, description and icon you would like, but it makes sense for them to refer to SquaredUp so that users can clearly see where the notifications are originating from.

4. Go to Incoming Webhooks and enable the Activate Incoming Webhooks option.
5. Click Add new Webhook to Workspace and choose the Slack channel you want to target.
6. Copy the URL.

Now use the webhook URL to configure the destination in SquaredUp:

1. A new destination can be configured when adding a notification rule in the Monitors section inside a workspace, or under Settings > Notifications

2. Destination Name:

   Enter a name for your destination. This helps you to identify this destination in the list of your destinations.

3. URL:

   Paste the webhook URL to configure the destination in SquaredUp.

4. Test:

   Use the Test button to send a test notification and check that it is working as expected.

   In Slack, when you click the View button in the notification you may get a warning triangle beside it. To fix this, add https://api.squaredup.com/api/slack_interaction as the Interaction URL.

Sending alerts to a Microsoft Teams channel is simple to configure:

1. Go to the Teams channel and select the Connectors option.
2. From the list of connectors, choose the Incoming Webhook connector and add it to the channel.
3. Give the webhook connector a name and icon. It makes sense to use a SquaredUp name and icon to make it clear that the alerts are coming from SquaredUp.
4. Click Create and you should be given a webhook URL.
5. Copy the webhook URL and then click Done.

Now use the webhook URL to configure the destination in SquaredUp:

1. A new destination can be configured when adding a notification rule in the Monitors section inside a workspace, or under Settings > Notifications

2. Destination Name:

   Enter a name for your destination. This helps you to identify this destination in the list of your destinations.

3. URL:

   Paste the webhook URL to configure the destination in SquaredUp.

4. Test:

   Use the Test button to send a test notification and check that it is working as expected.

Prerequisites:

• A SquaredUp API Key: In SquaredUp browse to Settings > API Keys > Create new API Key. Copy the API key to your clipboard.

Configure a new Zap in your Zapier web portal

1. In your Zapier portal, create a new Zap, selecting the SquaredUp integration for your Zap trigger.
2. When configuring the SquaredUp trigger, select the one available event, New Notification. This trigger is invoked when a new monitoring notification is raised by the SquaredUp platform.
3. Next, configure your secure connection with your SquaredUp account by connecting with the API Key you obtained earlier. You will also need to know if you are accessing our SquaredUp US or EU application region.

   If you access your SquaredUp application via the https://app.squaredup.com URL, this is the US region. https://eu.app.squaredup.com is our EU region.

4. After connecting successfully to your SquaredUp account with your API Key, you need to configure the trigger with a name for the Notification Destination that will be created. This is the name that will appear in your list of notification destinations in the SquaredUp application. Choose something meaningful like ‘My SquaredUp Zapier Integration’. This name needs to be unique and not clash with any existing notification destination names.
5. On the next step, click Test Trigger to see an example notification message that will be sent to Zapier when this trigger fires.

   This is sample data, not an actual notification alert.

6. At this stage, you can continue to set up the rest of your Zap, and select one or more actions to invoke as a result of any notifications.
7. Once your Zap is complete, save/publish your Zap. At this point, Zapier will create the Notification Destination in your SquaredUp application. You may need to refresh the list of Notification Destinations to see the newly created Zapier destination.
8. The last step is to utilize this new notification destination in the workspaces you wish to monitor. From any workspace, select Monitors on the left-hand nav bar, and add a new monitoring rule to use your newly created Zapier destination.

This option allows any webhook (HTTP POST endpoint) to be used to send notifications.

An example would be to use a third-party service like https://apify.com/ to send a customized email.

The JSON body of the webhook request is customizable, using inserts to specify elements of the notification – including the name of the monitored entity (e.g. SquaredUp Workspace name), the previous and new states, and a link back to the SquaredUp app.

This is an example of the JSON body:

{
  "text": "{{stateSymbol}} {{name}} changed from {{oldState}} to {{newState}}.",
  "link": "{{link}}"
}

This is just an example, and will need to be edited to match the requirements of the particular webhook being used. For example, this JSON is in the structure required for sending emails through apify.com:

{
  "subject": "{{stateSymbol}} {{name}} has changed from {{oldState}} to {{newState}}.",
  "html": "Hi there t<p>{{stateSymbol}} The health of <b><a href='{{link}}'>{{name}}</a></b> has changed from <b>{{oldState}}</b> to <b>{{newState}}</b>.<p style='color:blue;font-size:0.9em''><em>Brought to you by SquaredUp Alerts™</em>",
  "to": "[email protected]"
}

The SquaredUp destination configuration requires the webhook URL and JSON:

1. A new destination can be configured when adding a notification rule in the Monitors section inside a workspace, or under Settings > Notifications

2. Destination Name:

   Enter a name for your destination. This helps you to identify this destination in the list of your destinations.

3. URL:

   Paste the webhook URL to configure the destination in SquaredUp.

4. Body:
   Enter the JSON body for the channel.

5. Test:

   Use the Test button to send a test notification and check that it is working as expected.

A custom notification destination consists of a URL and a template for the message body that is POST-ed to the URL.

A web site like https://webhook.site can be used to experiment with custom notifications before integrating with your destination.

Supported webhooks

The webhook must take a JSON body passed via POST. It is not possible to pass headers. Authentication is not supported. The URL can include query parameters but they must be fixed - the URL cannot contain variables like the body.

Template structure

The body of the notification must be specified as a template. The template specifies the structure of the JSON passed to the webhook, along with variables that are replaced with details of the notification when each notification is sent.

A simple webhook body structure is

{
	"text": "{{stateSymbol}} {{name}} changed from {{oldState}} to {{newState}}."
}

The JSON is an object with a single text property. This structure works for many destinations - Slack, Teams, Google Chat etc. However, often more advanced structures can be used to give more options and more sophisticated formatting. Consult the documentation for the destination system to discover all of the options. A web search for incoming webhook and your destination type may prove useful.

Template variables

Template variables use the Mustache syntax. The following parameters are available.

Template variable tips

Normal text variables should use double-curly-brackets, e.g. {{name}}.

URLs should use triple-curly-brackets to avoid being broken by escaping, e.g. {{{link}}}.

Some variables are not populated for all notification types. To make a section of the template conditional on a variable having a value, use a conditional block, e.g. {{#var1}} This is only included if var1 has a value{{/var1}}.

Examples

Plain text

A simple notification that supports all notification types but does not include any details for tile monitor notifications. This will work with many destination types including Slack, Teams and Google Chat.

{
	"text": "{{stateSymbol}} {{name}} changed from {{oldState}} to {{newState}}. View in SquaredUp: {{{link}}}"
}

Plain text with tile monitor details (state reason, tile preview link)

This will work with many destination types including Slack, Teams and Google Chat.

{
	"text": "{{stateSymbol}} {{name}} changed from {{oldState}} to {{newState}}. {{#stateReason}}{{stateReason}}. {{/stateReason}}{{#imagePreviewUrl}}Tile preview: {{imagePreviewUrl}}. {{/imagePreviewUrl}}View in SquaredUp: {{{link}}}. Change your notification preferences: {{{notificationsConfigLink}}}"
}

Rich formatting using Slack ‘blocks’

This will only work with Slack.

{
	"blocks": [
		{
			"type": "section",
			"text": {
				"type": "mrkdwn",
				"text": "{{stateSymbol}} *<{{{link}}}|{{name}}>* changed from {{oldState}} to *{{newState}}*.{{#stateReason}}\n {{stateReason}}.{{/stateReason}}{{#tileName}}\nThis monitor is part of the <{{{dashboardLink}}}|*{{dashboardName}}*> dashboard in the <{{{workspaceLink}}}|*{{workspaceName}}*> workspace.{{/tileName}}{{#imagePreviewUrl}}\nTile preview <{{imagePreviewUrl}}|here>.{{/imagePreviewUrl}}\nChange your notification preferences <{{{notificationsConfigLink}}}|here>."
			}
		}
	]
}

Rich formatting using Teams ‘MessageCard’

This will only work with MS Teams.

{
	"@context": "https://schema.org/extensions",
	"@type": "MessageCard",
	"themeColor": "5D3FD3",
	"text": "{{stateSymbol}} [**{{name}}**]({{&link}}) changed from {{oldState}} to **{{newState}}**.",
	"sections": [
		{
			"text": "{{#stateReason}}{{stateReason}}. {{/stateReason}}{{#tileName}}This monitor is configured on the [**{{dashboardName}}**]({{&dashboardLink}}) dashboard in the [**{{workspaceName}}**]({{&workspaceLink}}) workspace.{{#imagePreviewUrl}}![Tile preview]({{&imagePreviewUrl}}){{/imagePreviewUrl}}{{/tileName}}",
			"potentialAction": [
				{
					"@type": "OpenUri",
					"name": "View",
					"targets": [
						{ "os": "default", "uri": "{{{link}}}" }
					]
				}
			]
		},
		{
			"text": "Change your notification preferences [**here**]({{{notificationsConfigLink}}})."
		}
	]
}