# Webhooks

![](https://4290574019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LO5CAzpxoaEquZJBpYz%2Fuploads%2Fgit-blob-f0803513a3c68ece7ce6467f4ea6a6a321135f9d%2Fwebhooks-header-v2.png?alt=media)

## 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
* Creating tickets in ITSM platforms like **ServiceNow** and **Jira**
* Integrating Keeper events into your custom software, hosted in the Cloud
* Developing integrations into Keeper using 3rd party automation platforms

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](https://docs.keeper.io/en/enterprise-guide/event-reporting#event-list) 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/XXX>

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

### Platform-Specific Guides

We have documented a few examples for popular endpoints below.

* [Slack](https://docs.keeper.io/en/enterprise-guide/webhooks/slack-webhooks)
* [Microsoft Teams](https://docs.keeper.io/en/enterprise-guide/webhooks/teams-webhooks)
* [Amazon Chime](https://docs.keeper.io/en/enterprise-guide/webhooks/amazon-chime-webhooks)
* [Discord](https://docs.keeper.io/en/enterprise-guide/webhooks/discord-webhooks)
* [ServiceNow ITSM](https://app.gitbook.com/s/-MJXOXEifAmpyvNVL1to/secrets-manager/integrations/servicenow-itsm)
* [Jira ITSM](https://app.gitbook.com/s/-MJXOXEifAmpyvNVL1to/secrets-manager/integrations/jira-itsm)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/en/enterprise-guide/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
