Webhooks

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 you receive a new email. It helps different apps talk to each other in real-time.

In DSPM+ webhook service allows you to subscribe for documents after cataloguing/classification stages. When doc passes Cataloging 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.

Please refer to the steps of setting up webhooks for DSPM and EDC.

Flow:

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

Open

 2. 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.

Open

3. Provide Callback URL from 'Your unique URL ' from webhook.site

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

Options explained:

• Webhooks dataset: A dataset in the context of webhooks is 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. Right now we have 2 types of datasets:

  • Files Dataset: This dataset contains information about files, such as their ID, types, path, version, etc.

  • Activity Dataset :This dataset captures activities or actions performed by users or systems, such as logins, updates, deletions, or other significant events

• 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.

Note: User also has the option to edit and delete a webhook.