Toggle Side Panel
Close search
View Categories

Notifications

4 min read

Overview #

When you’re working within your Cyclr Partner Console, the Dashboard provides a quick way to see the number of Tasks you’ve used from your Monthly Task Allowance, as well as how many are remaining:

Note: If you have a Private Cyclr Instance, you typically won’t have a Monthly Task Allowance so the Task Usage panel above won’t show a percentage indicator. In that situation, Notifications that relate to the Monthly Task Allowance – so those using a Type of “Percentage” or “Pro rata” – will not be triggered. Notifications using a Type of “Absolute” will still be triggered.

If you’re not often in your Console, or just wish to be notified as soon as possible, you can create “Notifications” to have Cyclr email you and your colleagues as your Task Usage moves towards your Monthly Task Allowance.

Warning: If you go over your Monthly Task Allowance you’re likely to be charged an additional fee for the extra Tasks used, as your Cycles will continue to run beyond your allowance.

Notifications are located here:

  • From your Cyclr Partner Console.
  • Go to Settings > Notifications in the left menu.

Note: If you have multiple Cyclr Partner Consoles hosted on the same Cyclr Instance, they are likely to be linked and share an overall Monthly Task Allowance. Because of this, your Notifications will be triggered when the total Task Usage across all of those Consoles reaches a Threshold value you’ve specified.

Create a Notification #

In your Cyclr Partner Console go to Settings > Notifications:

  1. Select the + Create Notification button in the top right of the page.
  2. A popup will be displayed where you can specify the following values:

Options:

  • Type – how a Notification will be used to check your Task Usage.
    Options are:
    • Percentage – checks how much of your Monthly Task Allowance has been used.
    • Pro rata – checks how much of your Monthly Task Allowance has been used when divided equally for each day in your Billing Period. Helps you to catch spikes in your usage.
    • Absolute – enables you to set a specific number of Tasks to have been used for a Notification to be triggered. Doesn’t require your Console to have a Monthly Task Allowance so can also be used by Cyclr Partners on Private Instances.
  • Threshold – the numeric value to compare against.
  • Emails – one or more email addresses for alert emails to be sent to.
  1. Select Create to add a new Notification.

Example Notifications #

You can create as many Notifications as you need with different Types to help you keep track of your Task Usage.

Here are some examples:

  • You could create multiple Notifications using Types of “Percentage” with Threshold values of 50, 75, 95, 100 and 110 so that you’re alerted as your Task Usage heads towards – and perhaps reaches or exceeds – your Monthly Task Allowance.
  • To identify when the number of Tasks being used is likely to exceed your Monthly Task Allowance, you could create a notification with a Type of “Pro rata” and – if you have a Monthly Task Usage of 10000 Tasks – divide that by 30 to find an approximate daily usage, then use that as the Threshold value, e.g. 330.
  • You may be interested when you reach certain specific numbers of Tasks used so could create Notifications using a Type of “Absolute” and setting a value of 10000, and another of 20000.

Notification Emails #

Cyclr runs hourly checks to see whether the criteria set in any of your Notifications has been reached. If it identifies any as having met their Threshold value, an email similar to this will be sent to the email addresses you have specified:

From: Cyclr <help@cyclr.com>
Subject: Cyclr Task Allowance Notification – 90% Usage

This is an automated email to inform you that you have consumed over 90% of your monthly task allowance. You have now used 900154 out of your total monthly allowance of 1000000 tasks.

Your integrations will, of course, continue to run uninterrupted even if you exceed your monthly task allowance but please be aware that task overages will be incurred for tasks used above your allowance. Your allowance will reset on 21st June 2023.

For questions or assistance, contact the Cyclr Support Team.

Note: The emails Cyclr sends have a From address of help@cyclr.com so be sure to add that to any safe sender/allow lists you use, to prevent them going into your Spam folder and being missed.