Skip to main content
POST
/
scanners
/
test-delivery
Test Draft Scanner Delivery
curl --request POST \
  --url https://oathnet.org/api/scanners/test-delivery \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "scanner_type": "stealer",
  "query_config": {
    "q": "alice@example.com",
    "email": "alice@example.com",
    "dbname[]": [
      "linkedin.com",
      "twitter.com"
    ],
    "wildcard": true,
    "extra_params": {
      "sort": "-indexed_at"
    }
  },
  "notification_type": "email",
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "webhook_security_mode": "api_key",
  "notify_on_zero_results": true
}
'
{
  "success": true,
  "notification_type": "<string>",
  "target": "<string>",
  "status_code": 123,
  "message": "<string>",
  "preview": {
    "event_name": "<string>",
    "search_url": "<string>",
    "security_mode": "<string>",
    "verification_method": "<string>",
    "authorization_scheme": "<string>",
    "encryption_enabled": true,
    "header_names": [
      "<string>"
    ],
    "body_kind": "<string>",
    "body_example": {}
  },
  "generated_webhook_secret": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oathnet.org/llms.txt

Use this file to discover all available pages before exploring further.

Validate and send a real test notification without saving the scanner first.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Body

application/json
​
name
string
​
scanner_type
enum<string>
Available options:
stealer,
breach
​
query_config
object

Persistent scanner search definition.

Scanners reuse the same flat filters and structured filter grammar as V2 search, but reject runtime-only params such as from, to, cursor, page_size, format, debug, and search_id. Scanner runs always execute on indexed_at.

Example:
{
  "q": "alice@example.com",
  "email": "alice@example.com",
  "dbname[]": ["linkedin.com", "twitter.com"],
  "wildcard": true,
  "extra_params": { "sort": "-indexed_at" }
}
​
notification_type
enum<string>
Available options:
email,
webhook,
discord
​
webhook_url
string
​
webhook_secret
string
​
webhook_security_mode
enum<string>
Available options:
api_key,
signed_json,
signed_encrypted
​
notify_on_zero_results
boolean

Response

200 - application/json

Raw delivery-test response

​
success
boolean
​
notification_type
string
​
target
string
​
status_code
integer
​
message
string
​
preview
object
​
generated_webhook_secret
string