Recipients: Difference between revisions
Telcredstaff (talk | contribs) No edit summary |
Telcredstaff (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
The purpose of ''Notifications'' is to generate an email, an SMS, or an HTTP request ("webhook") when certain |
The purpose of ''Notifications'' is to generate an email, an SMS, or an HTTP request ("webhook") when certain things happen (defined using a [[Commands and triggers|trigger]]). |
||
To create a new notification, select ''Notifications'' in the Monitoring section of the menu and click ''Add new''. |
To create a new notification, select ''Notifications'' in the Monitoring section of the menu and click ''Add new''. |
||
| Line 14: | Line 14: | ||
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]. |
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]. |
||
Select one or more [[Commands and triggers|triggers]] for which you want the notification to be sent. |
|||
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 specify a ''Maximum rate'' for the number of notifications that will be generated during e.g. one hour or a day. |
||
| Line 20: | Line 20: | ||
Multiple SMS recipients can be specified with comma (,) between each recipient, and the same is true for email recipients and HTTP recipients. |
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 |
|||
| ⚫ | |||
Revision as of 16:05, 29 March 2021
The purpose of Notifications is to generate an email, an SMS, or an HTTP request ("webhook") when certain things happen (defined using a trigger).
To create a new notification, select Notifications in the Monitoring section of the menu and click Add new.
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.
Select one or more triggers for which you want the notification to be sent.
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.
Finally, it is possible to limit the times during which notifications are sent by specifying a schedule for Only during and / or Unless during. If no schedule is specified, the notification will always be sent when the corresponding trigger fires.