Skip to main content

Update Target's Webhook

PUT 
/targets/:target_id/webhooks/:id/

Request​

Path Parameters

    id stringrequired
    target_id stringrequired

    Identifier of the target.r of the target.

Body

required

    name stringrequired

    Possible values: <= 255 characters

    Name of the webhook.

    url urirequired
    check_cert boolean

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

    api_version string

    Possible values: [v1]

    API version of the webhook.

    • v1 - V1

Responses​

Schema

    id stringrequired

    A unique Base58 value identifying this object.

    event_type stringrequired

    Possible values: [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]

    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_at date-timerequired

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

    object_type stringrequired

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

    content stringrequired

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

    webhooks

    object[]

    required

    Webhooks of the event.

  • Array [

    • id stringrequired
    api_version stringrequired

    Possible values: [v1]

    API version of the webhook.

    • v1 - V1
    status stringrequired

    Possible values: [scheduled, succeeded, rescheduled, failed]

    Status of the webhook:

    • scheduled - Scheduled
    • succeeded - Succeeded
    • rescheduled - Rescheduled
    • failed - Failed
    next_try date-timerequired

    Date and time of the next request to the webhook URL, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

    retries integer

    Possible values: >= -2147483648 and <= 2147483647

    Number of retries of requests to the webhook URL.

  • ]

Loading...