Beta v1.1

Installing and Configuring Chat Alerts

Step 1 -Registration

For each Core registration you'll need:

  • Individual/Company Name

  • Email Address

  • Volume License Number

Be sure all above matches the information used when initially registering on this website. An error in registration implies the information does not match. Your volume license number can be copied from the Dashboard.

Step 2 - Add Chat Webhooks

Select which software you'll use and follow the instructions for each to obtain your webhooks:

Paste the webhooks you want to use into the plugin making sure that they register in each chat you add them to.

Step 3 - Customize Chat Alerts

The plugin comes with ‘Warning & Error’ alerts preconfigured. In addition, you can receive Control Messages, Heartbeat Reports, and Custom Alerts.

  • Control Messages

    Control Messages are sent between Core’s (ie. port 1702, External Control Messages) or between the Core and another device (ie. port 1710, Crestron processors using Remote Control Protocol).

  • Heartbeat Reports

    Heartbeat Reports (HBR) will ping the room/space at a set frequency to ensure it is functioning (i.e. HBR every 7, 14, or 28 days).

  • Custom Alerts

    Custom Alerts are used to relay information from other components into Chat Alerts. To use, check the box under ‘Control Pins’ in the properties panel corresponding to the Custom Alert you want to use. Add a label describing the value. Next, connect the output control pin from the component to the Chat Alerts input pin.

Step 4 - Connect the Event Log

Almost done!

This is the last step in getting the Chat Alerts plugin working. Create an Event Log component in Designer and in the properties panel check the Lua Table box under 'Control Pins'. On the Chat Alerts plugin, check the 'Event Log' control pin and connect it to the Event Log output. This provides updated event log information and is vital for the Frequency and Category sections to work.

FAQ

Will I get Chat Alerts if I don't connect the Event Log symbol to the plugin?
Without the information from the Event Log, you can only receive messages that are Heartbeat or Custom Inputs.
Is a license used when I emulate a system or emulate just to test the plugin?
No, licenses are only consumed when registering a new Core and not when emulating or re-adding the plugin to a Core that has already been registered.
I only have one license to enter in the registration section but I purchased more than that.
Your single license key enables a new Core to be registered as many times as licenses you purchased. Each new Core you register will consume a single license no matter how many times you press 'Register' on that Core.
When I push 'Register', I get an error and nothing happens.
Please make sure you type your name in (caps included) exactly as you did when you purchased the license as well as your email and volume license number. If all of this is correct, please contact the developer at dev@redpointaudio.com