Provider Location Verification Webhook

Overview

This webhook is triggered whenever a provider's location is verified, updated, or flagged during HealthLink Dimensions' provider data validation process. When a trigger event occurs, HLD delivers a real-time JSON payload via HTTP POST to your configured endpoint.

Setup

To enable this webhook, share your receiving endpoint (a publicly accessible URL that accepts POST requests) with your HLD representative. HLD will configure your endpoint on our side to receive payloads.

Request Details

HLD sends a POST request to your registered URL with the following headers:

HeaderValue
Content-Typeapplication/json

Example request line:
POST /webhooks/provider-verification HTTP/1.1
Content-Type: application/json

Payload Schema

FieldTypeDescription
SourceRecordIDstringUnique record ID from the source system
SourceOrgIDstringOrganization ID in the source system
SourceProviderIDstringProvider ID in the source system
ProviderNPIstringNational Provider Identifier
FirstNamestringProvider's first name
LastNamestringProvider's last name
MiddleNamestringProvider's middle name (if any)
SufixNamestringSuffix (e.g., Jr, Sr)
TitlestringProfessional title (e.g., DDS, MD)
TaxonomystringProvider's taxonomy code
SpecialtystringProvider's specialty
SourceLocationIDstringLocation ID from the source system
LocationNamestringName of the clinic or practice
Address1stringStreet address line 1
Address2stringStreet address line 2 (optional)
CitystringCity of the location
StatestringState abbreviation
ZipstringZIP or postal code
PhoneNumberstringPhone number of the location
FaxNumberstringFax number (if available)
MemberEmailstringMember email associated with the location
ClinicEmailstringClinic's official email address
ContactNamestringContact person for the location
WebAddressstringWebsite URL
ProviderStatusstringStatus of the provider (ACTIVE, INACTIVE, etc.)
ProviderLocationStatusstringStatus of the provider at the location (e.g., NEW)
ProviderLocationStatusReasonstringReason for the provider's location status
OrgLocationStatusstringStatus of the organization at the location (e.g., NEW)
OrgLocationStatusReasonstringReason for the organization's location status
SpecialtyChangestringIf specialty changed, new value is shown
EffectiveDatestring (yyyy/mm/dd)Date the status change was verified
VerificationChannelstringHow the verification was performed (CALL, EMAIL, etc.)
VerificationSourcestringPhone number or source used for verification
VerifiedBystringName of the verifier
VerifiedDatestring (yyyy/mm/dd)When the verification occurred
ClientIDintegerInternal client identifier
SubclientIDintegerInternal subclient identifier
CustomField1stringCustom reference field (e.g., campaign ID)
Telehealthstring (Y/N)Indicates whether the provider offers telehealth services

Example Payload

{
  "SourceRecordID": "DAV-20034-2026-2797",
  "SourceOrgID": "23093",
  "SourceLocationID": "397759",
  "SourceProviderID": "796116",
  "ProviderNPI": "1417334293",
  "FirstName": "Gretchen",
  "LastName": "Galvin",
  "MiddleName": "E",
  "SufixName": "",
  "Title": "DDS",
  "Taxonomy": "122300000X",
  "Specialty": "GENERAL DENTIST",
  "LocationName": "Dr Bobs Dental Care",
  "Address1": "555 Jametown Ave",
  "Address2": "",
  "City": "Niagara Falls",
  "State": "NY",
  "Zip": "14304",
  "PhoneNumber": "7162975500",
  "FaxNumber": "7164376103",
  "MemberEmail": "[email protected]",
  "ClinicEmail": "[email protected]",
  "ContactName": "Dksjlx D Aszkr",
  "WebAddress": "",
  "ProviderStatus": "ACTIVE",
  "ProviderLocationStatus": "NEW",
  "ProviderLocationStatusReason": "",
  "OrgLocationStatus": "NEW",
  "OrgLocationStatusReason": "",
  "SpecialtyChange": "",
  "EffectiveDate": "2026/08/14",
  "VerificationChannel": "CALL",
  "VerificationSource": "7162975500",
  "VerifiedBy": "Rob J",
  "VerifiedDate": "2026/08/14",
  "ClientID": 2,
  "SubclientID": 19,
  "CustomField1": "DAV-20034-2026",
  "Telehealth": "N"
}

Handling the Webhook

Response: Your server should respond with HTTP status code 200 OK to acknowledge receipt.

Retries: If your endpoint does not respond with a 2xx status, HLD will retry delivery using exponential backoff.