Using Signal Policies to Trigger Webhook Actions

Before you begin

  • You must sign in to the SOTI MobiControl web console as a user with Manage Webhooks and Manage Signal Policies permissions.
  • You must have already created a webhook (see Creating a Webhook).

About this task

After creating a webhook, you must configure a signal policy to specify events and conditions that trigger the webhook and select the payload information to include in the webhook message.

Procedure

The steps below describe how to create a signal policy
  1. Select Main Menu > Policies > Signal
  2. In the Signal Policies panel, select the New Signal Policy icon .
    Webhooks new signal
Enter the signal policy name and description
  1. In the General tab of the Create Signal Policy panel, enter a Name and Description for the signal policy and select Next.
    Webhooks signal general information
Define the conditions for the signal policy to detect
  1. In the Conditions tab of the Create Signal Policy panel, select Add Condition.
    Webhook signal conditions
  2. In the Adding Condition panel, enter the conditions that trigger the signal policy. In this example, the signal policy must detect when Apple devices have less than 1 GB of memory. This step adds a condition to filter Apple devices.
    Webhook signal adding condition
  3. In the Conditions tab of the Create Signal Policy panel, select the Add icon to add another condition. This condition detects devices with less than 1 GB of available memory. This condition, together with the previous one creates a signal policy that detects when an Apple family device has less than 1 GB of memory.
    Webhook signal adding more conditions
  4. Select the values as displayed below and select Add.
    Webhook more signal condition details
    Note: You can add conditions to create more complex signal policies.
Select the device groups that the signal policy applies to
  1. The Conditions tab of the Create Signal Policy panel lists the conditions you have added.
    Webhook signal device groups
    Note: In the blue box, All conditions must apply for the signal policy to trigger. You can change this to Any to make the signal policy trigger when any of the conditions apply.
    Specify a target group of devices to apply the signal policy to by choosing Select Device Groups.
    Webhooks signal target devices
  2. Select Add to add the device group and then select Next in the Conditions tab of the Create Signal Policy panel.
Select the trigger webhook action and the select information to include in the webhook message payload
  1. In the actions tab of the Create Signal Policy panel, select Add Action.
    Webhooks signal add action
  2. In the Adding Action panel, select Trigger Webhook from the Action drop-down list. Select the Webhook for this policy to trigger. Enter a Subject for the signal policy. Select the attributes from the Source Attributes table to include in the webhook payload. Use the search bar to find specific device attributes. Select Add.
    Webhooks signal add action
    Note: When using the search bar to find device attributes, the Selected value in the blue box may change based on the attributes returned in the search.
    Note: A signal policy can choose from several different types of actions. Refer to the following table of signal actions from the Adding Signal Policy Actions section:
    OptionDescription
    Send Script
    Note: This selection only applies to conditions that include managed devices.

    Send the following types of scripts to devices when the action triggers:

    • Legacy
    • JavaScript
    • PowerShell 32-bit Compatibility
    • PowerShell Native
    Choose a script from Execute Following Script, then select its delivery method.
    Note: The Execute Following Script list populates from the Manage Scripts dialog box, containing previously saved scripts. See Manage Scripts and Sending Scripts to Devices.
    Send Email

    Send an email alert to recipients indicating the policy triggered. Add email contacts to the To, CC, and BCC fields by separating the addresses with a semicolon and no space between them.

    Use the Macro button in the Subject and Message text fields to add dynamic information, such as Device ID or Policy Name to the email.

    Send Message

    Send a message directly to devices that the policy triggered. You can limit the Display Duration of the message on the devices and choose a Type of message, such as Error or Warning.

    Relocate Device

    Automatically relocate devices that triggered the policy from their current device group to another of your choice.

    Trigger Alert

    Drive an alert to the SOTI MobiControl Notification Panel.

    Use the Macro button in the Alert Title and Message text fields to add dynamic information such as Device ID or Policy Name to the alert.

    Trigger Webhook Send automated JSON or XML data to a URL when the policy triggers. From Webhook, select a predefined webhook. Give a Subject for the destination URL, and select the Source Attributes to include in the payload data.
    Note: You can define webhooks in Global Settings > Services > Webhook.
    Tip: See Using Signal Policies to Trigger Webhook Actions for information on how to use a signal policy to trigger a webhook.
  3. In the Actions tab of the Create Signal Policy panel, a summary of the added actions displays. Select Next.
    Webhook signal action summary
    Note: You can make the signal policy trigger more actions by selecting the Add icon.
Optionally define the signal policy scheduling, activation and deactivation dates and times
  1. In the Scheduling tab of the Create Signal Policy panel, specify when the signal policy is in effect. Select Always to put the signal policy in effect immediately and indefinitely. Select Custom to specify the days and time during each week that the signal policy is in effect. In this example, the signal policy is active every Tuesday and Friday from 8:00 AM to 10:00 PM.
    Webhook signal scheduling
    Note: The default activation date and time when selecting Always as the Schedule Type is the date and time of the creation of the signal policy. By default, the deactivation date is not set, so the signal policy is in effect indefinitely.
    In the Advanced Settings part of the Scheduling tab, you can set activation and deactivation dates and times. If the optional Set Deactivation Date is not set, the signal policy remains in effect indefinitely. You can deactivate the policy by editing the policy and adding a deactivation date and time, or by deleting the signal policy.
    In the example below, the signal policy is in effect from 8:00 AM on June 12, 2023 to 10:00 PM on June 30, 2023.
    Webhhook signal advanced scheduling
  2. Select Finish to complete the creation of the signal policy. The newly created and activated signal policy displays in the Signal Policies panel.
    Webhooks signal added

Results

You are now able to create a signal policy, associate it with a webhook and select information to include in the webhook message payload.

What to do next

You can edit the webhook (see Editing Webhooks) or delete it (see Deleting Webhooks). You can also edit the signal policy to trigger under different conditions, trigger more or different webhooks or trigger different actions, such as run a script or send email. You can also edit the signal policy to change the information included in the webhook message payload.