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.

​
Supported Fields

FieldRequiredTypeRules and behavior
urlYesstringWebhook URL. Must be a valid HTTPS URL.
headersNoobjectCustom headers to include in the webhook request, such as { "X-Customer": "acme" }.
basicAuthNoobjectHTTP Basic Auth credentials with username and password.
secretNostringPer-target HMAC secret. Overrides the global webhook secret when present.
eventsNostring[]Event types delivered to this target. If omitted, defaults to ["verification.completed"]. Allowed values: verification.completed, verification.notification, verification.action_required.
searchTypesNostring[]For fallback targets, restrict delivery to specific search types. Allowed values: EMPLOYMENT, EDUCATION.
enabledNobooleanEnables or disables this target. Default: true.

​
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
}