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:
| Header | Value |
|---|---|
| Content-Type | application/json |
Example request line:
POST /webhooks/provider-verification HTTP/1.1
Content-Type: application/json
Payload Schema
| Field | Type | Description |
|---|---|---|
| SourceRecordID | string | Unique record ID from the source system |
| SourceOrgID | string | Organization ID in the source system |
| SourceProviderID | string | Provider ID in the source system |
| ProviderNPI | string | National Provider Identifier |
| FirstName | string | Provider's first name |
| LastName | string | Provider's last name |
| MiddleName | string | Provider's middle name (if any) |
| SufixName | string | Suffix (e.g., Jr, Sr) |
| Title | string | Professional title (e.g., DDS, MD) |
| Taxonomy | string | Provider's taxonomy code |
| Specialty | string | Provider's specialty |
| SourceLocationID | string | Location ID from the source system |
| LocationName | string | Name of the clinic or practice |
| Address1 | string | Street address line 1 |
| Address2 | string | Street address line 2 (optional) |
| City | string | City of the location |
| State | string | State abbreviation |
| Zip | string | ZIP or postal code |
| PhoneNumber | string | Phone number of the location |
| FaxNumber | string | Fax number (if available) |
| MemberEmail | string | Member email associated with the location |
| ClinicEmail | string | Clinic's official email address |
| ContactName | string | Contact person for the location |
| WebAddress | string | Website URL |
| ProviderStatus | string | Status of the provider (ACTIVE, INACTIVE, etc.) |
| ProviderLocationStatus | string | Status of the provider at the location (e.g., NEW) |
| ProviderLocationStatusReason | string | Reason for the provider's location status |
| OrgLocationStatus | string | Status of the organization at the location (e.g., NEW) |
| OrgLocationStatusReason | string | Reason for the organization's location status |
| SpecialtyChange | string | If specialty changed, new value is shown |
| EffectiveDate | string (yyyy/mm/dd) | Date the status change was verified |
| VerificationChannel | string | How the verification was performed (CALL, EMAIL, etc.) |
| VerificationSource | string | Phone number or source used for verification |
| VerifiedBy | string | Name of the verifier |
| VerifiedDate | string (yyyy/mm/dd) | When the verification occurred |
| ClientID | integer | Internal client identifier |
| SubclientID | integer | Internal subclient identifier |
| CustomField1 | string | Custom reference field (e.g., campaign ID) |
| Telehealth | string (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.

