Create Target's Webhook

POST 
/targets/:target_id/webhooks/

Request

Path Parameters

target_id stringrequired

Identifier of the target.

application/json

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

application/x-www-form-urlencoded

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

multipart/form-data

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

200

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

event_type stringrequired
Possible values: [user_created, user_deleted, target_created, target_deleted, target_verified, target_verification_failed, scan_started, scan_canceled, scan_completed, scan_failed, finding_detected, finding_fixed]
Type of event:
• user_created - User Created
• user_deleted - User Deleted
• target_created - Target Created
• target_deleted - Target Deleted
• target_verified - Target Verified
• target_verification_failed - Target Verification Failed
• scan_started - Scan Started
• scan_canceled - Scan Canceled
• scan_completed - Scan Completed
• scan_failed - Scan Failed
• 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.

]

Example (from schema)

{
  "id": "string",
  "event_type": "user_created",
  "occurred_at": "2024-07-29T15:51:28.071Z",
  "object_type": "string",
  "content": "string",
  "webhooks": [
    {
      "id": "string",
      "api_version": "v1",
      "status": "scheduled",
      "next_try": "2024-07-29T15:51:28.071Z",
      "retries": 0
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...