Work with Webhooks

Webhooks Overview

In evalink talos, Incoming Webhook integration allows you to create, configure and trigger incoming webhooks.

Webhooks act like a callback or push mechanism that sends HTTP requests to a specified URL when a certain event occurs. This allows you to automatically trigger alarms through a device or an endpoint, make API calls to evalink talos or third-party apps.

Using Incoming Webhook integration you can:

• Configure and receive real-time notifications for various events: user actions, status changes, alarm activations
• Use these notifications to automate certain workflow tasks in your external systems and devices
• Introduce improved communication between evalink talos and your IT infrastructure and ecosystem

Webhooks Integration allows you to perform actions that are also available in evalink talos API. However, you don't need experience of working with API to use Webhooks Integration. This makes API features available to users who don't have a background of working with APIs, in WYSIWYG mode.

Only Company Admins can configure Webhooks in evalink talos globally. On the site level, Company Admins and Managers can cofigure webhooks.

Configure Webhooks Integration Globally

To enable Webhooks Integration for each particular evalink talos site, you need to configure it on a global level.

To enable and configure webhooks globally:

1. Navigate to Company > Integrations

2. Scroll to Webhooks and click add Add Integration

   The configuration dialog opens.

   

   By default, when the configuration dialog opens, the integration is enabled.

3. Click Submit

The connection status of the integration becomes Enabled.

Edit Webhooks Integration

Editing Webhooks Integration on a global level means enabling or disabling it.

To edit Webhooks Integration:

1. In the Company > Integrations tab, scroll to Webhooks and click build Edit Integration

2. Toggle the Enable / Disable slider to the desired position.

3. Click Submit

   info

   You can also disable the Webhooks Integration by selecting the Disable option in the corresponding more_vert three dots menu.

When you disable Webhooks integration, its global connection status becomes Disabled.

Delete Webhooks Integration Globally

Use this option if you want to delete the integration and all its corresponding data from evalink talos completely. If you don't want to delete the data, use the disable option. It keeps the integration data, but the integration is no longer available at particular evalink talos sites in your tenant.

To delete Webhooks Integration:

1. In the Company > Integrations tab, click more_vert three dots menu next to the Webhooks Integration record

2. In the dialog that opens, type the delete confirmation

3. Click Delete

Configure Webhooks Integration for a Site

After you have enabled Webhooks Integration in a global level, it becomes available for all sites in your tenant under the Sites > (Site Name) > Integrations tab.

To add a Webhooks Integration for a site:

1. Navigate to Sites > (Site Name) > Integrations tab

2. Switch to the Webhooks subtab

   

3. Click Create Webhook

   The Create Webhook dialog opens.

   info

   The Create Webhook dialog has two tabs. The Base tab allows you to configure general webhook settings. The Dynamic Templates tab allows you to configure mapping for headers that you want an alarm triggered by the webhook to contain.

4. In the Name Field, type the name of the webhook

5. In the Alarm Code field, select the alarm code for the alarm which the webhook will trigger

6. (Optional) In the Zone field, specify the zone on the site for which the alarm is to be triggered

7. (Optional) Check the following flags the alarm needs to have:

   • Technical
   • Test Message
   • Restore

8. (Optional) Enable Periodic Invocation if you want to receive alarms if the webhook is not triggered for a period of time

9. (Optional) Enable Authentication if you want to limit who can use this webhook to authorized users only

10. If you used the previous step, specify username and password in the two corresponding additional fields that appear

11. Click Submit

Viewing Webhook Details

Once you create a webhook, its record becomes available in the Integrations > Webhooks tab for the site.

There are 2 URLS evalink talos creates for each webhook:

• Machine Endpoint URL

  Use this URL to call the webhook from third-party applications or in evalink talos workflows. evalink talos sends back the outcome of the call in JSON format.

• Web Endpoint URL

  Use this URL to call the webhook manually through a user-friendly web user interface.

You can use the corresponding copy options to copy the webhook URLs to clipboard.

Each webhook record also has an Enable / Disable toggler which you can use.

Each webhook record also contains data about the last time it was invoked.

Add Headers to Webhooks

You can configure which additional information an alarm triggered by a webhook contains. To do this:

1. In the Create Webhook / Edit Webhook dialog, switch to the Dynamic Templates tab

2. Specify the following values if necessary:

   • Alarm Code
   • Alarm Zone
   • Alarm Zone Name
   • Partition ID
   • Partition Name
   • User ID
   • User Name
   • Alarm Message
   • Technical (True or False)
   • Test message (True or False)
   • Alarm Value (True or False)
   • Payload

3. Specify additional headers by clicking add New Header

   Use pebble language to specify header values.

   Here is an example of specific headers added to a webhook created for various camera events:

   

4. Click Submit

Edit a Webhook

To edit a webhook:

1. In the Integrations > Webhooks subtab of a site, find the webhook record you want to edit

2. Click the corresponding Edit button

3. Edit the webhook details as desired

4. Click Submit

Export Webhooks

You can export webhook information as a JSON file and use it on another site.

To export a webhook:

1. 1. In the Integrations > Webhooks subtab of a site, find the webhook record you want to edit

2. Click the corresponding Export icon

3. In the File Explorer window that opens, specify the exported file name and location

4. Click Save

Import Webhooks

You can import a JSON file with webhook data to any site. It is best practices to use webhook files previously exported from evalink talos to make sure the JSON formatting is correct.

To import a webhook:

1. In the Integrations > Webhooks subtab of a site, click the Import icon at the top of the list of webhook records

2. In the File Explorer window that opens, navigate to the JSON webhook file you want to import

3. Select the file and click Open

   The new webhook record is added to your site. By default, it is disabled.

Delete a Webhook

When you delete a webhook from a site, all its configurations are deleted as well. If you want to keep the webhook settings, but don't want to use it, use the Disable option instead.

To delete a webhook:

1. In the Integrations > Webhooks subtab of a site, locate the webhook record that you want to delete

2. Click the corresponding Delete button for the webhook record

3. In the dialog that opens, type delete confirmation

4. Press Confirm Delete

Triggering Webhooks

Once you have configured a webhook, you can trigger it from a web browser, a third-party device or application, or use it as part of a workflow for this site.

info

For more information about Trigger Webhooks workflow step, see section Trigger Webhooks as Part of a Workflow.

You can use the Web Endpoint URL from any device to trigger the webhook.

The figure below shows and example what you see in a browser if you follow the Web Endpoint URL. You can trigger the webhook by clicking Trigger button. When you do this, an alarm configured for this webhook, arrives.

You can also use the Machine Endpoint URL for various third-party devices and applications: connected alarm management systems or devices, for example, smart doorbells, such as 2N Intercom.