Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Events

Partial Update Target's Webhook

patch/targets/{target_id}/webhooks/{id}/

Path parameters

idstring required

A unique Base58 value identifying this object.

target_idstring required

Identifier of the target.

Request body

idstring

A unique Base58 value identifying this object.

namestring

Name of the webhook.

urlstring uri
check_certboolean

If true, verify the HTTPS certificate of the webhook URL. Defaults to true.

api_version'v1'

API version of the webhook.

  • v1 - V1
createdstring date-time
changedstring date-time

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

Response

idstring required

A unique Base58 value identifying this object.

event_type'user_created' | 'user_deleted' | 'target_created' | 'target_deleted' | 'target_verification_failed' | 'scan_started' | 'scan_canceled' | 'scan_completed' | 'scan_failed' | 'scan_paused' | 'scan_under_review' | 'finding_detected' | 'finding_fixed' required

Type of event:

  • user_created - User Created
  • user_deleted - User Deleted
  • target_created - Target Created
  • target_deleted - Target Deleted
  • target_verification_failed - Target Verification Failed
  • scan_started - Scan Started
  • scan_canceled - Scan Canceled
  • scan_completed - Scan Completed
  • scan_failed - Scan Failed
  • scan_paused - Scan Paused
  • scan_under_review - Scan Under Review
  • finding_detected - Finding Detected
  • finding_fixed - Finding Fixed
occurred_atstring date-time required

Date and time of when the event occurred, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

object_typestring required

Type of object returned in the content of the event.
Can have one of the following strings: "user", "target", "scan", or "finding".

contentstring required

Content of the event.
Can have one of the following objects: User, Target, Scan, or Finding.