Skip to main content

​
WebhookTargetDto Schema

Defines a single webhook destination with optional custom headers, per-target secret, basic auth, and filters to control which events and search types it receives.

​
Fields

​
Example

{
  "url": "https://client.example.com/webhooks/employment-closeout",
  "headers": { "X-Customer": "acme" },
  "basicAuth": { "username": "api", "password": "secret" },
  "secret": "per-target-secret",
  "events": ["verification.completed", "verification.notification"],
  "searchTypes": ["EMPLOYMENT"],
  "enabled": true
}