Control4 UniFi Protect / Access / Network: Receiving Custom Webhooks

This guide describes how to trigger actions in control4 based on custom UniFi Webhooks. This can be used to perform actions based on advanced UniFi triggers which may not be handled directly. 

Procedure

The Chowmain UniFi Drivers must be 20251215 or later. Custom Webhooks requires a local UniFi Controller

1. Ensure that the Primary Control4 Controller utilises a static IP, or a reserved DHCP address. If the Control4 IP address controller changes IP, the UniFi applications may be unable to trigger the custom webhooks. Ensure that the latest firmware is in use by UniFi
2. Log into the UniFi Controller. Select the correct Application (Protect, Network or Access)
3. Open Alarm Manager. Please note, on some controllers, this may be found in a different location. For the latest info, check UniFi's documentation  
4. Create an Alarm 
5. Set the Alarm Conditions and name as required 
6. Using the Custom Webhook URL Property in the Controller driver in Control4, set the webhook action. Change <CUSTOM_WEBHOOK_NAME> to a reference name to use. Set Delivery Method to "POST". It is not recommended to have spaces in the Delivery URL. Press Create 

Using the Webhooks in Control4

1. Control4 provides 2 variables you can program against. The webhook url is capitalised (as an example, for 192.168.1.1/custom/Arrival, LAST_CUSTOM_WEBHOOK_NAME will contain "ARRIVAL". For more info about the current state, use Variables Agent  
2. As an alternative, events can be used instead. Set the "Auto Create Events For Custom Webhooks" Property to "Automatic", and events will be created as they are triggered 

Some webhooks may trigger rapidly, and require a debounce using a timer (via the timer agent), to block the event being fired multiple times in a second. Ensure you test all webhooks

• Related Articles

• CONTROL4 UNIFI PROTECT: Trigger Custom Webhooks

  The Unifi protect application allows Custom webhooks to be created which Control4 can trigger. This provides a deeper level of integration with Unifi for less common commands or command flows. Custom Webhooks can be used for commands such as: ...

• Control4 UniFi: Manual Setup of UniFi Network Device

  Control4 UniFi: Manual Setup of UniFi Network Device It is strongly recommended to use Auto Setup to correctly configure and add new devices instead of Manual Setup Ensure that UniFi Network Controller has been added to project and is correctly ...

• CONTROL4 UNIFI: Setup API keys correctly to avoid Error 401 / Unauthorised Error

  Important Notice UniFi Access doesn't use the same API Key as UniFi Protect/Network. Keys created for Protect / Network will not work. If the incorrect key is used, you will get a 401 / Unauthorised error in API Connection Status Setting Up UniFi ...

• Control4 Unifi Protect: Accessing Camera History Snapshots and recordings

  Problem Control4 does not provide access to third party developers to attach snapshots and video to the built in Camera interface history. To provide Solution Chowmain have developed a custom NVR interface which is built into the UniFi Protect ...

• CONTROL4 UNIFI: Setting Up UniFi Face Detection and LPR (Licence Plate) Detection on Unifi Protect

  Preparation Ensure that our UniFi Protect Controller driver is configured Ensure That the UniFI Controller and driver is running the latest update Ensure that both API and Login Connection Status is OK Ensure that Display Diagnostics shows no ...