User Docs
PlatformProduct updates
  • Getting started
    • What is DSPM?
    • Use DSPM in your company
    • Choose how to run DSPM
  • Quick start
  • Deployment guide
    • Sizing
    • Installation
      • Understand installation requirements
        • K3S installation
        • Configuring a HA K3s cluster
        • Configuring Rancher and Fleet agent to run behind an HTTP proxy
        • Install Synergy/Focus/Enterprise using Helm without Rancher
        • Install Synergy/Focus/Enterprise using Rancher
        • Air Gap Installation
        • Uploads to Rancher
      • Upgrade K3s
        • K3s - Upgrade
      • Troubleshooting
        • K3s on RHEL/CentOS/Oracle Linux
        • Networking
        • Configuring Rancher and Fleet agent to run behind a HTTP proxy if cluster was previously registered
    • Estimate hardware capacity needs
  • Administration guide
    • Customer Support Portal
    • Pattern matching
    • Data Controls
    • Analytics
    • Detectors
    • Import custom TLS certificate
    • GQL Quick Guide
    • Critical & Sensitive Classification Attribute Modification
    • How to Check AI Mesh Version
    • Webhooks
    • AI Mesh Overview
    • Is Customer Data Saved by Getvisibility?
  • Enterprise setup
    • Authentication
      • Keycloak configuration
      • Single Sign-on (SSO)
        • Using Azure AD as Keycloak Identity Provider
      • Keycloak User Federation Configuration (LDAP/AD)
      • Enable 2FA
      • Role-Based Access Control (RBAC)
      • Keycloak User Federation using LDAP over SSL
  • Implementation
    • Configuring Taxonomies & Labels
  • Integrations
    • GQL
    • Template Language
    • Multi-Language Machine Learning
    • SIEM Integration
    • Google Drive Auto-labelling
  • Scan with Getvisibility
    • Configure detectors
    • Configure data sources
      • Scan Configuration Fields
      • AWS IAM
      • AWS S3
      • Azure AD
      • Azure Blob
      • Azure Files
      • OneDrive
      • SharePoint Online
      • SharePoint on-premise
      • Box
      • Confluence Cloud
      • LDAP
      • SMB
      • Google IAM
      • Google Drive
      • ChatGPT
      • iManage
      • Dropbox
    • Scanning
      • Data Source Permissions
      • Scan Scheduler
      • Types of Scan
      • Scan History
      • Scan Analytics
      • Supported Languages for ML Classifiers
      • Rescan Files
    • Streaming
      • What is DDR?
      • How to Configure DDR Rules
      • Import Data Controls
      • Monitoring New Files via DDR Streaming
      • DDR Supported Events
      • Lineage
      • Supported Data Sources
      • Azure Blob Streaming Configuration
      • Azure Files Streaming Configuration
      • Confluence Cloud Streaming Configuration
      • Sharepoint Online Streaming Configuration
      • SMB Streaming Configuration
      • OneDrive Streaming Configuration
      • Azure AD Streaming Configuration
      • AWS S3 Streaming Configuration
      • Google Drive Streaming Configuration
      • Google IAM Streaming Configuration
      • AWS IAM Streaming Configuration
      • Box Streaming Configuration
      • Dropbox Streaming Configuration
    • Enterprise Search columns meaning
    • Supported File Types
  • Glossary
  • FAQ
  • EDC - All Documents
    • Deployment - Onboarding
      • EDC-Server Installation Guide
      • EDC-Deployment Flow Guide
        • EDC-installerConfig.json and CLI config Details
      • Deploying the agent using ManageEngine
      • EDC-Mac Agent - Installation Guide
      • Windows Agent Precheck Script
    • Functionality - Guides
      • EDC - Admin Guide - v4
      • EDC -Guide for writing Visual Labels
      • EDC- Guide for Header Footer Options
      • EDC-Metadata Details
      • EDC Supported File Types
      • Agent V4 - Configuration Options for Expert Mode
      • File Lineage - Agent Activities
      • Endpoint Data Discovery
    • Troubleshooting Documents
      • Preventing Users From Disabling Agent
      • Generate Installation Logs
      • Troubleshooting Agent for Windows
      • Guide for missing suggestions
      • Reseller Keycloak Quick Installation Guide
      • Alternative authentication methods for agent
  • EDC - All Documents
Powered by GitBook
On this page
  • Flow:
  • Webhooks dataset:
  • GQL query
  • Callback URL
  • Name
  • Webhooks status

Was this helpful?

Export as PDF
  1. Administration guide

Webhooks

How to configure a Webhook.

PreviousHow to Check AI Mesh VersionNextAI Mesh Overview

Last updated 3 months ago

Was this helpful?

A webhook is a way for one application to automatically send information to another application when something specific happens. For E.g. getting an instant message when a new email is received. It helps different apps talk to each other in real-time.

In DSPM+, the webhook service makes it possible to subscribe to documents after cataloguing/classification stages. When a document passes Cataloguing or Classification, based on GQL provided in webhook and callback URL is sent to the target system (client system). Similarly in EDC webhook can be used to send information to client system based on activity of the users.

Flow:

  1. Go to the dashboard: Administration -> Webhooks -> Create webhook.

  1. Provide URL from 'Your unique URL ' from webhook.site; input GQL; name and webhook status. Please see below for the description of all the options.

Webhooks dataset:

A collection of data that serves as the content triggering the webhook or being sent by the webhook to a specified endpoint. When an event occurs that matches certain conditions, the webhook system will package relevant data from the dataset and send it to a predefined URL.

Files

This contains information about files, such as their ID, types, path, version, etc. This information is based on content related to DSPM

Activity Dataset

This dataset captures activities or actions performed by users or systems, such as logins, updates, deletions, or other significant events. This is mainly from endpoint Agents.

Streaming

This dataset relates to live events and the content connected to DDR.

GQL query

This query language is designed to enhance the flexibility and efficiency of querying data through DSPM+,DDC and EDC platforms. It enables users to craft custom queries without the need of hard coding, significantly simplifying the process of filtering through and analyzing the data. On the webhook page it can be used to setup information using the datasets available.

Callback URL

A callback URL is a specific URL endpoint provided by a user or a system to receive data from another system when a certain event occurs. When the event is triggered, the webhook sends an HTTP POST request to the callback URL, delivering the relevant data payload. This mechanism allows real-time communication between systems, enabling automated workflows and immediate data synchronization

Name

This filed allows user to give a unique and meaningful name to the webhook.

Webhooks status

Users can create multiple webhooks and choose whether to keep it active or deactivate it based on the requirement.

User also has the option to edit and delete a webhook

Provide Callback URL from 'Your unique URL ' from

If there are some scans in progress, data in cataloguing/classification-result in some moments you'll see requests coming to (if not - manually scan a folder).

webhook.site
webhook.site