BriteCore webhooks connect policy, billing & claim workflows with external systems through the BriteCore Integration Platform. They are designed to support reliable, validated, and reusable integrations for claims, payments, property data, policy data, contact screening, vehicle data, document delivery, and event distribution.
How BriteCore webhooks work?
Each webhook is registered as an integration point with:
- A unique integration point code
- A clear business purpose
- A validated request schema
- A validated response schema
- Example request, response, and error payloads
When an integration is installed through the Integration Catalog, BriteCore stores the workflow trigger URL for each enabled integration point. When the related BriteCore workflow runs, BriteCore posts the payload to that URL as JSON.
Standard outbound behavior:
- Method: POST
- Content type: application/json
- Direction: BriteCore to Vendor
- Response style: Synchronous JSON response
- Timeout: 30 seconds
BriteCore integration layer handles the downstream vendor workflow, such as transforming data, calling a vendor API, or returning a hosted experience URL.
Integration installation and configuration
BriteCore webhooks are configured through the Integration Catalog in Settings > Vendor Integrations.
An installed integration can include:
- One or more integration point connections
- BriteCore integration solution instance
- A workflow trigger URL for each integration point
- Policy type scoping, when the integration should only apply to selected policy types
- Environment-specific configuration for production, sandbox, or mock workflows
BriteCore also supports integration notifications so administrators can be alerted when an integration workflow encounters an error.
Webhook types
BriteCore webhooks fall into three main categories.
| Type | Direction | Description |
| Outbound integration point | BriteCore → Vendor | BriteCore sends a JSON request and receives a synchronous response. |
| Bidirectional integration | BriteCore ↔ Vendor | BriteCore starts a workflow, and Vendor later posts results back to BriteCore. |
| BriteCore inbound endpoint | Vendor → BriteCore | Vendor calls a BriteCore API endpoint directly, often for callbacks or scheduled processing. |
Available webhook integration points
POST /api/v2/integrations/list_integration_points
Returns the integration points supported by BriteCore and documents each integration point’s contract. For every integration point, the response includes its code, description, serialized request/response/error schemas, and example request/response/error payloads.
Field reference:
- data.integration_points[]: All supported integration points, sorted by code.
- code: Stable integration point code.
- description: Human-readable description of the integration point.
- request_schema: Serialized schema describing the request payload.
- response_schema: Serialized schema describing a successful response payload.
- error_schema: Serialized schema describing an error payload.
- request_samples: Example request payloads.
- response_samples: Example successful response payloads.
- error_samples: Example error payloads.
Address Suggestion
Code: ADDRESS_SUGGESTION
The Address Suggestion webhook sends address details to a configured provider and returns standardized address suggestions.
Typical request data includes:
- Address line 1
- Address line 2
- City
- State
- ZIP or postal code
- Country
Typical response data includes one or more suggested addresses with standardized address fields.
Auto Loss History Prefill
Code: AUTO_LOSS_HISTORY_PREFILL
The Auto Loss History Prefill webhook retrieves prior auto claim history for named insureds or drivers during quoting, renewal, or endorsement workflows.
Typical request data includes:
- Contacts
- Names
- Dates of birth
- Optional Social Security numbers
- Optional addresses
- Driver license details
- Named insured and driver relationships
Auto Loss History Prefill Renewal
Code: AUTO_LOSS_HISTORY_PREFILL_RENEWAL
This webhook supports renewal quoting flows by retrieving prior claim information for auto policies.
It follows the same general pattern as Auto Loss History Prefill, with request data tailored to renewal processing.
Auto Policy Data Prefill
Code: AUTO_POLICY_DATA_PREFILL
The Auto Policy Data Prefill webhook retrieves available policyholder, driver, vehicle, and policy data that can be used to prefill an auto quote or application.
Typical request data can include:
- Policyholder name
- Address
- Social Security number
- Date of birth
- Vehicle information
- Driver information
- Policy state
Typical response data may include vehicle attributes, driver records, garage codes, anti-theft codes, and related policy information.
BriteApps eDelivery Enrollment Initiation
Code: BRITEAPPS_EDELIVERY_ENROLLMENT_INITIATION
This webhook initiates enrollment for BriteApps document e-delivery.
It is used when a user or workflow starts an e-delivery enrollment process and an external workflow needs to coordinate the enrollment experience.
Check Issuance
Code: CHECK_ISSUANCE
The Check Issuance webhook sends outgoing payment details to an external check issuance provider.
Typical request data includes:
- Payment details
- Payee contact information
- Mailing address
- Email address
- Phone number
- Related claim or policy payment context
Claim Estimation
Code: CLAIM_ESTIMATION
The Claim Estimation webhook creates or cancels claim estimation assignments with a third-party estimation provider.
Typical request data includes:
- Claim number
- Loss date
- Loss causes
- Adjusters
- External adjusters
- Supervisors
- Carrier information
- Insured information
- Claim exposures
- Policy details
- Assignment ID
- Action: create or cancel
Typical response data includes:
- External estimation reference
- Vendor
- Status
- Success indicator
Claim Vehicle Valuation
Code: CLAIM_VEHICLE_VALUATION
The Claim Vehicle Valuation webhook retrieves an estimated vehicle value for a claim vehicle.
Typical request data includes claim and vehicle information. The response returns valuation details from the configured provider.
Contact Credit Report Retrieval
Code: CONTACT_CREDIT_REPORT_RETRIEVAL
This webhook retrieves a credit report for a contact.
Typical request data includes:
- Contact name
- Address
- Social Security number
- Date of birth
The integration validates required combinations of contact data before sending the request.
Contact Screening
Code: CONTACT_SCREENING
The Contact Screening webhook provides a standard interface for screening contacts against external services.
It can be used for workflows that require contact validation, eligibility checks, or external screening results.
Driving Records Prefill
Code: DRIVING_RECORDS_PREFILL
The Driving Records Prefill webhook retrieves motor vehicle record data for drivers.
Typical request data includes:
- Driver identity information
- License number
- License state
- Driver relationship data
Typical response data can include:
- Driving record details
- Accident codes
- Violation codes
- Violation descriptions
- License information
Event Integration
Code: EVENT_INTEGRATION
The Event Integration webhook sends BriteCore domain events to an external event bus.
Typical request data includes:
- Event ID
- Event date
- Topic
- Schema ID
- Version
- Event payload
- Triggering user information
A successful response is an empty JSON object.
Example event topics may include events such as quote creation, policy changes, or other domain activity configured for event delivery.
Verisk ClaimSearch
Code: CLAIMS_SEARCH
The ClaimSearch integration submits claim data for prior-loss matching. BriteCore sends claim data to the integration layer that converts the request, and ClaimSearch returns results asynchronously.
Supported submission types include:
- Initial — first notice of loss submission
- Replacement — full overwrite after material claim data changes
- Research — manual or scheduled re-search
- Update — update-style submission where supported by the workflow
Typical request data includes:
- Request ID
- Submission type
- Request source
- User ID, when applicable
- Claim information
- Policy information
- Parties
- Adjusters
- Coverages
- Carrier
- Risks
- Payments
Typical synchronous response values include:
- Scheduled
- Failed
The final ClaimSearch result is delivered through the inbound callback endpoint.
NxTech Uploader
Code: NXTECH_UPLOADER
The NxTech Uploader webhook supports integrations with NxTech and IVANS-related vendor products.
It is used for workflows that need to upload or transmit BriteCore data to the configured vendor process.
Payment Processor
Code: PAYMENT_PROCESSOR
The Payment Processor webhook supports the current hosted payment user interface approach.
It is designed for payment workflows where the external provider hosts the payment collection experience, helping reduce direct handling of sensitive payment data inside BriteCore workflows.
Legacy Payment Processing
Code: PAYMENT_PROCESSING
The Legacy Payment Processing webhook supports older payment integrations that use raw payment method data.
This approach is deprecated in favor of the hosted payment user interface pattern.
Property Inspection
Code: PROPERTY_INSPECTION
The Property Inspection webhook starts a property inspection workflow.
It supports both interactive and non-interactive flows.
Interactive flows can return:
- A start URL for an embedded iframe
- Recommended iframe width
- Recommended iframe height
Non-interactive flows can return:
- A workflow execution message
- A workflow execution log URL
Typical request data includes:
- Property ID
- Property revision ID
- Property name
- Requested inspection date
- Property address
- Latitude and longitude, when available
- Policy ID
- Policy number
- Requester contact ID
- Skip form indicator
- Optional form payload
Embedded inspection content can notify the parent page when the inspection request is completed or cancelled.
Property Lookup
Code: PROPERTY_LOOKUP
The Property Lookup webhook retrieves structured property data from an external provider.
It can support property-specific lookup options and return available data for a property location.
Property Valuation
Code: PROPERTY_VALUATION
The Property Valuation webhook starts a property valuation workflow through an external provider.
It is commonly used when a user needs valuation information during quoting, underwriting, or property review workflows.
Quote Wizard Plugin: Above Submit Button
Code: QUOTE_WIZARD_PLUGIN_ABOVE_SUBMIT_BUTTON
This webhook renders a quote wizard plugin above the submit button.
It allows an integration to add contextual content or an embedded workflow into the quote wizard before submission.
Quote Wizard Plugin: After Risk Rating
Code: QUOTE_WIZARD_PLUGIN_AFTER_RISK_RATING
This webhook renders a quote wizard plugin below the property rating section.
It can be used to display external workflow content, rating-related context, or additional actions after risk rating is complete.
Vehicle Attributes Prefill
Code: VEHICLE_ATTRIBUTES_PREFILL
The Vehicle Attributes Prefill webhook retrieves vehicle attributes from vehicle information.
Typical request data includes:
- Vehicle type
- Year
- Make
- Model
- VIN
Typical response data can include:
- Anti-theft code
- Garage code
- Body style
- Vehicle specifications
- Other supported vehicle attributes
Request and response validation
BriteCore validates webhook payloads against explicit schemas.
Validation helps ensure that:
- Required fields are present
- Field types are correct
- Enumerated values are allowed
- Nested objects follow the expected structure
- Responses from external workflows are predictable
For outbound integration points, BriteCore expects the external workflow to return a response that matches the integration point response schema.
For inbound endpoints, Vendor must send the expected request structure so BriteCore can process and store the result.
Authentication and access
Authentication depends on webhook direction.
For outbound integration points, BriteCore posts to the configured workflow trigger URL associated with the installed integration.
For inbound callbacks from Vendor to BriteCore, Vendor uses the BriteCore API authentication configured for the integration. This allows Vendor to call approved BriteCore API endpoints, such as ISO ClaimSearch result storage or scheduled research triggers.
Manual user-initiated actions, such as requesting ISO ClaimSearch from the BriteCore UI, require the appropriate authenticated BriteCore user permissions.
Best practices for webhook workflows
Use these practices when configuring or maintaining BriteCore webhook integrations:
- Keep workflow trigger URLs secure and scoped to the intended integration.
- Return responses that match the configured response schema.
- Keep synchronous workflow responses fast and predictable.
- Use asynchronous callbacks for long-running vendor processes.
- Include clear error codes and error messages when a workflow fails.
- Avoid changing payload shapes without coordinating schema updates.
- Scope integrations to policy types when only certain products should use the integration.
- Monitor integration error notifications to quickly identify workflow issues.