Account

Register a webhook for pushed findings

Free and unmetered. Registers one URL to receive findings (breach, infostealer, session hijack, ransomware victim listing, asset-intel matches) as they are detected, instead of polling. Post an empty webhook_url to clear the registration.

Billing. Free. This endpoint is not metered.

Note. Delivery is best-effort and fired inline with the originating call under a 6-second budget. A slow or failing endpoint never fails the API call that triggered it, so do not treat the webhook as a guaranteed-delivery channel -- poll for anything you must not miss.

post/v1/webhook/configure

Request

  • Base URL: https://api.relayshield.net
  • URL: https://api.relayshield.net/v1/webhook/configure
  • Auth: one of:
    • API key in header X-RS-API-KEY
    • HTTP bearer

Request body

webhook_urlstring uri required

An https:// URL to receive findings. Send an empty string to clear.

Response

Success. ok is true and data holds the result.

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.