Scan completed Notifications

Overview

Scan Completed webhook notifications allow you to receive real-time alerts whenever an Instant or Scheduled scan has finished running in MetaDefender Storage Security. This feature is useful if you need to:

  • Track the completion status of scans for auditing and compliance.
  • Monitor whether scans succeed, fail, or are cancelled.
  • Integrate scan lifecycle events into external systems (e.g., scheduling dashboards, reporting tools, SIEM).
  • Trigger automated follow-up processes once a scan has completed.

Setup

  1. Go to Settings > Notifications in the MetaDefender Storage Security console.
  2. Select Send a webhook notification when a scan is completed under the Webhook Notifications section.
  3. Enter the Destination Address (your endpoint).
  4. Select the Request Type (POST or PUT).
  5. (Optional) Add any custom HTTP headers.
  6. Save the configuration.

Configuration Details

  • Destination address – The URL of the receiving system (must accept HTTP requests).
  • Request type – Either POST or PUT.
  • Headers – Optional key-value pairs (e.g., Authorization: Bearer <token>).

Webhook Payload

When triggered, the webhook sends a JSON request body to your configured endpoint.

Webhook Notification Payload
Copy

Field Reference

FieldTypeExample ValueDescription
ScanIdstring(UUID)01987f90-870a-7826-9115-18d96a1a4ae0Unique identifier of the scan.
ScanNamestringsecond-scanName of the scan as configured.
StartTimedatetime (UTC)2025-08-06T13:27:14.953181ZTime the scan started.
StopTimedatetime (UTC)2025-08-06T13:27:20.12684ZTime the scan finished.
StatusstringCompleted /Cancelled /FailedFinal status of the scan.
WebhookNotificationTypestringScanCompletedIdentifies the notification type.

Delivery Behavior

  • Webhooks are delivered as standard HTTP requests.
  • Delivery is best-effort → if the destination is invalid, the request is logged in the Audit page, but no retries are performed.
  • Payload size is small (JSON only, no scan contents).

Security Considerations

  • Configure HTTPS endpoints to ensure data is transmitted securely.
  • Use authentication headers (e.g., API tokens) to protect your webhook endpoint.
  • Ensure your endpoint validates payloads before processing.

Troubleshooting

  • No webhook received → Verify the endpoint URL and request type (POST/PUT).
  • Audit shows delivery failed → Endpoint is invalid or unreachable. Fix and test again.
  • Authentication errors → Confirm your endpoint accepts the headers you configured.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
File scanned notifications
On This Page
Scan completed NotificationsOverviewSetupConfiguration DetailsWebhook PayloadField ReferenceDelivery BehaviorSecurity ConsiderationsTroubleshooting