Create Webhook Channels

Webhooks are automated messages sent from applications when an event occurs. When a specific event happens—like a new user being created, a password reset, or a suspicious login attempt—JumpCloud can automatically send a notification to an external application or service like JIRA. You can set up webhook notification channels to get alerts delivered to specified URLs.

To create a webhook:

1. Login to JumpCloud Admin portal.
2. In the left navigation, click Settings.
3. Go to Notification Channels. 
   
   
   
4. Click Webhooks.
5. Click +Add to add a webhook channel. The Create Webhooks page displays the Details tab.
   
   
   
6. For Webhook Status, the Enabled button is selected by default. Leave it as is to activate the channel immediately after saving. You can switch the button to Disabled if you prefer to enable the channel later. 
7. Enter a name for the webhook channel.

8. In the URL field, copy and paste the URL that you want to send notifications to.
9. The Verify SSL Certificate checkbox is selected by default.
   • When enabled, self-signed certificates are allowed during webhook delivery.
   • When disabled, self-signed certificates are not allowed, and the webhook delivery will fail if one is used.
10. If you have specific data in the URL that you want to protect, select the Protect sensitive data in the URL checkbox.
    1. In the Replacement Value field, enter the text you want to appear in the URL in place of the sensitive information. For instance, you could use a generic term like Token.
    2. In the Sensitive Value column, enter the sensitive data that you want to be masked in the URL. Click the eye icon to view the sensitive value.
    3. Click Add to add more sensitive data. You can add up to 10 rows of data.

11. Add Authentication as required. Select None if you don’t want to add any.
    1. Basic Authentication: Authenticate using a username and password.
       • Enter the Username and Password in the respective fields. Use the eye icon to show or hide the password.
    2. Token Authentication: Authenticate by providing a generated token.
       • Copy and paste the token in the Auth Token field.

12. Click Add Header to add headers as required.
    1. Copy and paste the API key and Value in the respective fields.
    2. You can use the Sensitive Value toggle to hide the value.
       • If you choose to hide the value here, this preference will be saved with the channel and you won't be able to change it later. 
       • You can use the Delete icon to delete the header and create a new one.
    3. Click Add Header to add more rows. You can add up to 25 headers.
13. Click Test Webhook to test the webhook channel configurations. A simulated request and response is displayed in a modal. Click Close.
14. Once you’ve verified the configurations, click Save.

The webhook channel is now created and visible on the Webhook page. If you Disabled the webhook channel during configuration, simply click the ellipsis icon next to it and click Enable to activate it. 

Webhook Payloads

The following is a list of the payload fields that you receive as part of the webhook notification.

Using Webhooks Channels

Next, you must create a rule and add the webhook channel within the rule to generate alert notifications. See Configure Rules for JumpCloud Alerts to learn more.

For Access Requests, you do not need to create a separate rule to set up webhooks. Simply create a webhook channel, then navigate to Security Management > Access Requests to select the specific events for which you wish to receive notifications via webhooks. See Configuring Access Requests Settings to learn more.

If you want to associate the webhook with a rule to receive notifications for specific events, you must create an Insights Rule. See Create an Insights Rule to learn more.