Creating a Webhook

Before you begin

  • You must sign in to the SOTI MobiControl web console as a user with Manage Webhooks permissions.
  • You must have an endpoint URL (where to send the webhook message) with the required sign in credentials.

About this task

When events or conditions occur in SOTI MobiControl, you can use a signal policy to detect them and trigger a webhook to send a message to an endpoint URL. This section describes how to configure a webhook. The Using Signal Policies to Trigger Webhook Actions section describes how to configure a signal policy to detect events and conditions, select payload information and trigger a webhook.

Procedure

The steps below describe how to create a webhook.
  1. Select Main Menu > Global Settings > Services > Webhook
  2. In the Webhook panel, select the Add icon .
    Webhooks add new
Enter the webhook name and endpoint URL
  1. In the Add Webhook panel, enter a Name for the webhook and the endpoint URL, (the URL to send the webhook message to). If authentication is not needed, select None as the authentication option.
    Webhooks general details
Configure the authentication type
  1. To use Basic authentication, enter the Username and Password credentials for the endpoint URL.
    Webhook authentication basic
  2. To use API Key authentication, enter an API key and value pair. Select whether to add the authentication information to the message header or the query parameters.
    Webhook authentication API
Define the message format and test the connection
  1. Select either JSON or XML for the webhook message format.
    Webhook format
  2. Select Test Connection to verify the endpoint URL is reachable based on the webhook connection information you have provided. You can test the connection with any of the authentication options.
    Webhook test connection
    A success notification displays if the test succeeds.
    Webhook add test connection succeeds
  3. Select Save to complete the process of adding the webhook. The newly created webhook appears in the Webhook panel.
    Webhooks go to signal policy
    Note: To add a signal policy to trigger the webhook, select Go to Signal Policies in the blue box.

Results

You have created a webhook.

What to do next

After adding a webhook, you must associate a signal policy to trigger the webhook (see Using Signal Policies to Trigger Webhook Actions). Signal policies define the conditions that trigger a webhook and the information to include in the webhook message.