Skip to main content

​
CloseoutEndpointsDto Schema

The CloseoutEndpointsDto defines specific webhook endpoints for different search types. It now supports multiple webhook targets per search type, with optional custom headers, basic auth, and event filters.

​
Fields

​
Complete Example

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

​
Usage Notes

  • All fields are optional - specify only the search types you need
  • Endpoints must be valid HTTPS URLs
  • If a search type endpoint is not specified, the fallbackEndpoint from WebhookConfigDto will be used
  • When events is omitted, the webhook defaults to receiving only verification.completed (backward compatible)
  • You can attach per-target headers and basic auth; HMAC signature header will still be sent (per-target secret overrides global secret)

​
Next Steps