Skip to navigation
API ReferenceWebhook Endpoints

Send a test delivery

Queues a real, signed issue.created delivery of the workspace’s most recent finding, whatever the endpoint subscribes to. With no findings it sends a synthetic issue labelled VULN-SAMPLE. Read the delivery log for the outcome. A disabled endpoint returns 409.

Requires the settings:write API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Path parameters

endpointIdstringRequired
Webhook endpoint UUID.

Response

The delivery was queued.
deliveryIdstringformat: "uuid"
endpointIdstringformat: "uuid"
eventenum
Allowed values:
sampleboolean
True when the workspace had no findings and a synthetic one was sent.
issueIdstring or nullformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error