Event-Based request format

Overview

This document describes the real-time webhook API endpoint that external integrators can use to notify the system about file events. The endpoint accepts different payload formats depending on the storage type.

Endpoint Information

URL: https://{baseurl}/api/webhook/realtime

Method: POST

Content-Type: application/json

Request Format (with examples)

The request body differs based on storage type. Below are the specifications for each supported storage:

Amazon S3 and S3 Compatible

Format
Example (file in root)
Example (file in nested directory)

Alibaba Cloud

Format
Example (file in root)
Example (file in nested directory)

Google Cloud, OracleSdk, Azure Blob, SMB Compatible, NFS, SFTP, FTP and NetApp ONTAP

Format
Example (file in root)
Example (file in nested directory)

Scanning with a partition

If you have one or more partition Event-Based scans active, a new parameter called scanId is required with every request and the format will become:

JSON

##

Response Formats

Success

When a webhook is successfully processed, the system returns:

Success response example

Error

When an error occurs during processing, the system returns:

Error response example

Common error responses

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Event-Based Real-Time Cloud Functions Examples
On This Page
Event-Based request formatOverviewEndpoint InformationRequest Format (with examples)Amazon S3 and S3 CompatibleAlibaba CloudGoogle Cloud, OracleSdk, Azure Blob, SMB Compatible, NFS, SFTP, FTP and NetApp ONTAPScanning with a partitionResponse FormatsSuccessErrorCommon error responses