Webhook target
Single webhook destination with optional headers, auth, and event filters.Fields
| Field | Required | Type | Description |
|---|---|---|---|
url | Yes | string | Webhook URL. |
headers | No | object | Custom headers to include in the webhook request, such as { "X-Customer": "acme" }. |
basicAuth | No | object | HTTP Basic Auth credentials with username and password. |
secret | No | string | Per-target HMAC secret. Overrides the global webhook secret when present. |
events | No | string[] | Event types delivered to this target. If omitted, defaults to ["verification.completed"]. Allowed values: verification.completed, verification.notification, verification.action_required. |
searchTypes | No | string[] | For fallback targets, restrict delivery to specific search types. Allowed values: EMPLOYMENT, EDUCATION. |
enabled | No | boolean | Enables 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
}