5 of 5

Webhooks

Integrate Keeper Webhook events into Slack, Microsoft Teams and other cloud services.

What are Webhooks?

Webhooks are user-defined HTTP requests that are triggered by an application and pushed into other applications.

Popular uses of Webhooks are the following:

Sending realtime notifications to Slack, Microsoft Teams or other messaging platforms
Integrating Keeper events into your custom software, hosted in the Cloud
Developing integrations into Keeper using 3rd party platforms such as IFTTT

The Keeper Admin Console supports the ability to push custom Webhook events.

Global Event Variables

When sending a Webhook, you can substitute fields with one of the below variables.

Name

Description

#alert_name

Title of the event as appears in the Admin Console

#description

Description of the Event. See reporting & alerts page for list of all possibilities.

#timestamp

Time which the event occurred

#remote_address

External IP address of the user generating the event

#username

User who generated the alert or could be empty depending on the event

#json

Raw JSON event data (useful for debugging and inspecting fields)

Dynamic Event Variables

Depending on the type of event, there are other variable substitutions available.

Name

Description

#to_username

For sharing events, the destination user

#from_username

For sharing events, the source user

#record_uid

For Record events, the Record identifier

#shared_folder_uid

For Shared Folder events, the folder identifier

#folder_uid

For Folder-specific events, the folder identifier

#team_uid

For Team events, the Team identifier

#role_id

For Role events, the Role ID

#node

For Node events, the Node ID

#enforcement

For Role Policy changes, the enforcement name

#seats

For MSP events, the number of seats

#seats_added

For MSP events, the number of seats added

#seats_removed

For MSP events, the number of seats removed

URLs

You can also include hyperlinks for convenience into various areas of the Keeper platform. A few examples:

Vault Login URLs:

US: https://keepersecurity.com/vault
EU: https://keepersecurity.eu/vault
AU: https://keepersecurity.com.au/vault
CA: https://keepersecurity.ca/vault
JP: https://keepersecurity.jp/vault
US_GOV: https://govcloud.keepersecurity.us/vault

Admin Console URLs:

US: https://keepersecurity.com/console
EU: https://keepersecurity.eu/console
AU: https://keepersecurity.com.au/console
CA: https://keepersecurity.ca/console
JP: https://keepersecurity.jp/console
US_GOV: https://govcloud.keepersecurity.us/console

Deep Links

Keeper supports Deep Linking into the Web Vault for a particular Record UID. Example:

https://keepersecurity.com/vault/#detail/XXXXXX

replace XXXXXX with the Record UID as it appears in the Keeper record or substitute #record_uid
Make sure to replace .com with the proper domain as listed above

Platform-Specific Guides

We have documented a few examples for popular endpoints below.

Slack
Microsoft Teams
Amazon Chime
Discord

Slack Webhooks

Send Keeper advanced reporting and alert notifications to Slack

Slack Setup and Integration

Using the Webhook feature, you can send custom alerts and actions to your Slack channel following the steps below.

(1) Go to https://api.slack.com/apps and Create a new app

(2) Name the App, select your desired Workspace and click Create App.

(3) Click on Incoming Webhooks

(4) Activate the Webhook and click "Add New Webhook to Workspace.

(5) Select the Slack channel you would like the alerts to be sent. Then click "Copy" to grab the Webhook URL required to plug into the Admin Console interface in the following steps.

(6) In the "Basic Information" section on the left, you can populate the icon with the Keeper icon. Right-click and save the image Use the link below to download a 512x512 PNG icon for Keeper: https://keeper-email-images.s3.amazonaws.com/common/Keeper_512x512.png

(7) Login to the Keeper Admin Console and visit Reporting & Alerts > Alerts and create a new alert. After selecting the desired Event Types and Attributes, click on "Add Recipient". In the example below, I have selected all Policy Changes.

(8) Enter the Name and Email address to receive the event, and click Add Webhook.

(9) Paste the Webhook URL from Step 5 and copy and paste the HTTP body content below

(10) Copy-paste the below JSON content into the HTTP Body section.

{
  "text": "Keeper Security Event",
  "blocks": [
    {
      "type": "section",
      "fields": [
        {
          "type": "mrkdwn",
          "text": "*Alert Name*\n#alert_name"
        }
      ]
    },
    {
      "type": "section",
      "fields": [
        {
          "type": "mrkdwn",
          "text": "*Event Details*\n#description"
        }
      ]
    },
    {
      "type": "section",
      "fields": [
        {
          "type": "mrkdwn",
          "text": "*IP Address*\n#remote_address"
        },
        {
          "type": "mrkdwn",
          "text": "*Timestamp*\n#timestamp"
        }
      ]
    },
    {
      "type": "actions",
      "elements": [
        {
          "type": "button",
          "text": {
            "type": "plain_text",
            "text": "Vault Login",
            "emoji": true
          },
          "value": "vault",
          "url": "https://keepersecurity.com/vault",
          "action_id": "actionId-1"
        },
        {
          "type": "button",
          "text": {
            "type": "plain_text",
            "text": "Console Login",
            "emoji": true
          },
          "value": "console",
          "url": "https://keepersecurity.com/console",
          "action_id": "actionId-2"
        }
      ]
    }
  ]
}

(10) Click Save on the recipient and Save the alert.

That's it. Please note that it can take up to 15 minutes for events to start transmitting. You can modify the HTTP Body according to your preferences. Slack's Block Kit Builder allows you to customize the look and feel completely.

Creating new Webhook body content and editing content may take up to 15 minutes to take effect.

Shared Record Notifications

Another use case is to be notified when a record is added to a particular Shared Folder.

(1) Follow the Slack setup steps above to create a baseline Slack integration.

(2) In the Web Vault, grab the Shared Folder UID that you would like to report on

(3) On the Admin Console, create a new Alert for this event that is tracking "Add Record to Shared Folder"

(4) Under the Attributes section, paste the Shared Folder UID

(5) Under "Recipients", create a new Webhook recipient.

(6) Copy Paste the below JSON text body into the HTTP Body section. In the "text" field, you will want to edit it to match up with the alert that you are creating.

{
  "text": "Keeper - Added Record to Shared Folder",
  "blocks": [
    {
      "type": "section",
      "fields": [
        {
          "type": "mrkdwn",
          "text": "*Alert Name*\n#alert_name"
        }
      ]
    },
    {
      "type": "section",
      "fields": [
        {
          "type": "mrkdwn",
          "text": "*Event Details*\n#description"
        }
      ]
    },
    {
      "type": "section",
      "fields": [
        {
          "type": "mrkdwn",
          "text": "*IP Address*\n#remote_address"
        },
        {
          "type": "mrkdwn",
          "text": "*Timestamp*\n#timestamp"
        },
        {
          "type": "mrkdwn",
          "text": "*Record UID*\n#record_uid"
        }
      ]
    },
    {
      "type": "actions",
      "elements": [
        {
          "type": "button",
          "text": {
            "type": "plain_text",
            "text": "Open Record",
            "emoji": true
          },
          "value": "vault",
          "url": "https://keepersecurity.com/vault/#detail/#record_uid",
          "action_id": "actionId-1"
        },
        {
          "type": "button",
          "text": {
            "type": "plain_text",
            "text": "Console Login",
            "emoji": true
          },
          "value": "console",
          "url": "https://keepersecurity.com/console",
          "action_id": "actionId-2"
        }
      ]
    }
  ]
}

Teams Webhooks

Send Keeper advanced reporting and alert notifications to Microsoft Teams

Microsoft Teams Setup and Integration

To send rich formatted alerts to your Microsoft Teams platform, follow the instructions below:

(1) From the Teams main screen, go to applications and search for incoming webhooks. Click Add to a team.

OR click ... on an existing channel and choose "Connectors".

(2) Give it a name and click "Create".

(3) Click the copy button next to the URL

(4) Login to the Keeper Admin Console and visit Reporting & Alerts > Alerts and click on an existing alert or create a new one.

(5) Select Recipients > Add Recipients

(6) Type in the Recipient Name and email address and click Add Webhook.

(7) Paste the Webhook URL from Step 3 and then copy and paste the content for the HTTP body below.

(8) Copy this JSON content and paste it into the HTTP Body section in the screenshot above.

{
    "@type": "MessageCard",
    "@context": "http://schema.org/extensions",
    "themeColor": "0076D7",
    "summary": "Alert: #alert_name",
    "sections": [{
        "activityTitle": "#description",
        "activitySubtitle": "#alert_name",
        "activityImage": "https://keeper-email-images.s3.amazonaws.com/common/Keeper_512x512.png",
        "facts": [{
            "name": "User",
            "value": "#username"
        }, {
            "name": "Timestamp",
            "value": "#timestamp"
        }, {
            "name": "IP Address",
            "value": "#remote_address"
        }],
        "markdown": true
    }]
}

(10) Click Save on the recipient and click Save on the alert.

That's it. Please note that it can take up to 15 minutes for events to start transmitting. You can modify the HTTP Body according to your preferences. See the Microsoft Connectors website to customize the look and feel completely.

Creating new Webhook body content and editing content may take up to 15 minutes to take effect.

(Optional) Testing Webhooks from the Command Line

For Mac / Linux users, a quick way to test your format is to use curl:

Put the Webhook content into a test file such as test.json
Run the Curl command with the following syntax, replacing URL with your Slack or Teams URL

# On Mac and Linux:
curl -X POST -H 'Content-type: application/json' -d @test.json <WEBHOOK URL>

# On Windows
curl.exe -H "Content-Type:application/json" -d @test.json <WEBHOOK URL>

Amazon Chime Webhooks

Send Keeper advanced reporting and alert notifications to Amazon Chime chats

Amazon Chime Webhooks Setup

Setting up a Webhook in Amazon Chime is straightforward and can be done in just a few steps. Follow the instructions below to create a Webhook for your Chime chat room:

(1) Log in to Amazon Chime

Access Amazon Chime: Open the Amazon Chime app on your desktop or go to the web version at Amazon Chime Web.
Log in: Enter your credentials to log in to your Amazon Chime account.

(2) Select a Chat Room

Navigate to the Chat Room: From the Chime home screen, find and select the chat room where you want to receive notifications via Webhook.
Open Room Settings: Click on the room name at the top of the chat window to open the room settings.

(3) Access Webhook Settings

Scroll to Integrations: In the room settings, scroll down to the Integrations section.
Add Webhook: Click on Add Webhook. This will bring up the Webhook creation interface.

(4) Create the Webhook

Name the Webhook: Enter a name for your Webhook (e.g., “Keeper Alerts”). This name is for your reference and helps you identify the Webhook later.
Create the Webhook: Click Create to generate the Webhook URL.

(5) Copy the Webhook URL

Copy the URL: After the Webhook is created, a unique Webhook URL will be displayed. Copy this URL as you will need it to send notifications to the chat room.

(6) Login to the Keeper Admin Console and visit Reporting & Alerts

Login to the Keeper Admin Console and visit Reporting & Alerts > Alerts and create a new alert. After selecting the desired Event Types and Attributes, click on "Add Recipient".
Enter the Name and Email address to receive the event, and click Add Webhook.
Paste the Webhook URL from Step 5
Copy-paste the below JSON content into the HTTP Body section.

{"Content": "**Keeper Security Event**\n\n**Alert Name:** #alert_name\n**Event Details:** #description\n**IP Address:** #remote_address\n**Timestamp:** #timestamp\n\n[Vault Login](https://keepersecurity.com/vault)\n[Console Login](https://keepersecurity.com/console)"}

(7) Click Save on the recipient and Save the alert

Creating new Webhook body content and editing content may take up to 15 minutes to take effect. Chime Webhooks primarily use simple text messages and support basic Markdown formatting.

Reference:

https://docs.aws.amazon.com/chime/latest/ug/chat-webhooks.html

Discord Webhooks

Send Keeper advanced reporting and alert notifications to Discord

Discord Setup and Integration

Using the Webhook feature, you can send custom alerts and actions to your Discord server following the steps below. In this example, we are creating a new server, but the webhook can also be set up with an existing Discord server.

(1) Click on the + symbol in the top left corner of your Discord account to Add a Server.

(2) After clicking on Create My Own (or selecting a template), select whether the server is for yourself or for a community.

(3) Customize your server with an icon and a name, then click Create.

(4) You have now created your own Discord server! After clicking on the server name, a dropdown menu will open. From there, click on Server Settings.

(5) On the left-side menu, first select Integrations, then click on Create Webhook.

(6) After customizing the webhook to your liking (name and icon), click on Copy Webhook URL.

(7) Next, login to the Keeper Admin Console and visit Reporting & Alerts. First click on Alerts, then click on an existing alert or create a new one.

(8) After selecting the desired Event Types and Attributes, click on Add Recipient.

(8) Type in the Recipient Name and Email Address and click Add Webhook.

(9) Paste the Webhook URL from Step 6, then copy and paste the content for the HTTP body below. Lastly, click Save.

(10) Copy this JSON content and paste it into the HTTP Body section in the screenshot above.

{
  "content": "Keeper Security Event",
  "embeds": [
    {
      "title": "Alert Name",
      "description": "#alert_name",
      "fields": [
        {
          "name": "Event Details",
          "value": "#description"
        },
        {
          "name": "IP Address",
          "value": "#remote_address"
        },
        {
          "name": "Timestamp",
          "value": "#timestamp"
        }
      ],
      "footer": {
        "text": "Keeper Security Notification"
      }
    }
  ]
}

That's it! Below you can find an example of a Discord Webhook alert. Please note that it can take up to 15 minutes for events to start transmitting. You can modify the HTTP Body according to your preferences.

References: