To enhance the capabilities of your monitoring services, you can now use Webhooks to trigger devices, websites, or other smart hubs to perform a pre-programmed action based on the events generated by the camera or monitoring operators. By providing a URL, our system can send information about the event, and you can choose what information will be included within the webhook.
To create a new webhook, select a customer and go to the Alerts menu. From there, open the Webhooks tab and click on the "Create Webhook" button. You can test your link using Ping, and if the link address is correct and there is a reply from it, you will be taken to the next step.
On the next screen, you can choose one or more event types that will trigger the webhook. Use Select all or Deselect all links to add or remove all event types from the webhook. Click the Next button to proceed.
Note: In our platform, "Analytics" refers to any object detection event generated by our platform or smart cameras. When setting up webhooks, selecting "Analytics" as an event trigger equates to selecting object detection.
To choose what cameras will be included in the webhook alert choose the role which contains those cameras. If you need to choose cameras that belong to multiple roles you will need to create a new role that will include all the cameras first and then create a new webhook using this new role. To learn more about roles please visit this page.
Also, you can choose what information will be included within the webhook, to do this choose Payload.
3dEYE JSON Payload will have basic information about the camera and events that happened in it:
Bold SIMS XML Payload will allow you to assign two fields for each role and two fields for each camera and receive a URL to review the event.
To change Bold SIMS XML Payloads for a role use edit or open role and edit it from the role properties window:
or from the Role properties window:
To edit Bold SIMS XML Payload fields for the camera open camera properties and go to the Integrations tab
Note: For Object detection events (Analytics) webhook will be triggered if the confidence level of the system for a selected object is higher than the limit set on the Analytics tab of the camera.
To learn more about confidence and object detection please visit this page.
To Delete a Webhook, open the webhook you want to delete by clicking on its name. Then go to Delete and type in "DELETE" to confirm the deletion of the webhook and the delete button will turn red.
For information on how to set up successful monitoring operations follow this page↗️