Recipients: Difference between revisions

From Telcred documentation
Jump to navigation Jump to search
No edit summary
No edit summary
Line 12: Line 12:
The ''Description'' field is included in both emails and SMSs.
The ''Description'' field is included in both emails and SMSs.


HTTP requests contain a full description of the event in the form of a JSON object.
HTTP requests contain a full description of the event in the form of a JSON object. The full webhook specification can be found [https://v1telcredaccessmanagerwebhooks.docs.apiary.io/# here].


Multiple ''Event types'' can be included in a single notification. For example, you can create a notification called "Tamper alarm", and include the event types ''Controller Tamper'' and ''Reader tamper''.
Multiple ''Event types'' can be included in a single notification. For example, you can create a notification called "Door alarm", and include the event types ''Door forced open'' and ''Door left open''.


It is possible to specify a ''Maximum rate'' for the number of notifications that will be generated during e.g. one hour or a day.
It is possible to limit the times during which notifications are generated by specifying a schedule for ''Only when'' and / or ''Unless when''. If no schedule is specified, the notification is always active.


Multiple SMS recipients can be specified with comma (,) between each recipient, and the same is true for email recipients and HTTP recipients.
It is also possible to specify a ''Maximum rate'' for the number of notifications that will be generated during e.g. one hour or a day.


Notifications can be filtered on a number of parameters, so that only events involving e.g. certain doors or certain users trigger a notification. The possible filter parameters are:
Multiple SMS recipients can be specified with comma (,) between each recipient, and the same is true for email recipients.

* Controllers
* Devices
* Doors
* Methods
* Users
Finally, it is possible to limit the times during which notifications are generated by specifying a schedule for ''Only during'' and / or ''Unless during''. If no schedule is specified, the notification is always active.

Revision as of 09:41, 27 February 2019

The purpose of Notifications is to generate an email, an SMS, or an HTTP request ("webhook") when certain events occur.

To create a new notification, select Notifications in the main menu and click Add new.


Create notification


The Name field is is included in emails as part of the subject.

The Description field is included in both emails and SMSs.

HTTP requests contain a full description of the event in the form of a JSON object. The full webhook specification can be found here.

Multiple Event types can be included in a single notification. For example, you can create a notification called "Door alarm", and include the event types Door forced open and Door left open.

It is possible to specify a Maximum rate for the number of notifications that will be generated during e.g. one hour or a day.

Multiple SMS recipients can be specified with comma (,) between each recipient, and the same is true for email recipients and HTTP recipients.

Notifications can be filtered on a number of parameters, so that only events involving e.g. certain doors or certain users trigger a notification. The possible filter parameters are:

  • Controllers
  • Devices
  • Doors
  • Methods
  • Users

Finally, it is possible to limit the times during which notifications are generated by specifying a schedule for Only during and / or Unless during. If no schedule is specified, the notification is always active.