Legacy | Docs

Locations: Webhook Webhook

Sends an updated Location to your server.
Request Body schema: application/json

The updated Location
	object
	object
	Array of objects
Request samples

Payload
Content type
application/json
{"meta": {"eventType": "LOCATION_CREATED",
"uuid": "string",
"timestamp": "string",
"accountId": "string",
"appSpecificAccountId": "string"
},
"location": {"id": "string",
"uid": "string",
"accountId": "string",
"timestamp": 0,
"timezone": "string",
"locationType": "LOCATION",
"locationName": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"officeName": "string",
"gender": "FEMALE",
"npi": "string",
"address": "string",
"address2": "string",
"suppressAddress": true,
"displayAddress": "string",
"city": "string",
"state": "string",
"sublocality": "string",
"zip": "string",
"countryCode": "st",
"serviceArea": {"radius": 0,
"unit": "string",
"places": ["string"
]
},
"phone": "string",
"isPhoneTracked": true,
"localPhone": "string",
"alternatePhone": "string",
"faxPhone": "string",
"mobilePhone": "string",
"tollFreePhone": "string",
"ttyPhone": "string",
"categoryIds": ["string"
],
"featuredMessage": "string",
"featuredMessageUrl": "string",
"websiteUrl": "string",
"displayWebsiteUrl": "string",
"reservationUrl": "string",
"displayReservationUrl": "string",
"menuUrl": "string",
"displayMenuUrl": "string",
"orderUrl": "string",
"displayOrderUrl": "string",
"hours": "string",
"additionalHoursText": "string",
"holidayHours": [{"hours": "string",
"date": "2019-08-24",
"isRegularHours": false
}
],
"description": "stringstri",
"conditionsTreated": ["string"
],
"certifications": ["string"
],
"educationList": [{"type": "FELLOWSHIP",
"institutionName": "string",
"yearCompleted": "string"
}
],
"degrees": ["string"
],
"admittingHospitals": ["string"
],
"acceptingNewPatients": true,
"closed": {"isClosed": true
},
"paymentOptions": ["string"
],
"insuranceAccepted": ["string"
],
"logo": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"photos": [{"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
}
],
"headshot": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"videoUrls": ["string"
],
"instagramHandle": "string",
"twitterHandle": "string",
"googleWebsiteOverride": "string",
"googleCoverPhoto": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"googleProfilePhoto": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"googleAttributes": [{"id": "string",
"optionIds": ["string"
]
}
],
"facebookPageUrl": "string",
"facebookCallToAction": {"type": "NONE",
"value": "string"
},
"facebookCoverPhoto": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"facebookProfilePicture": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"uberLinkType": "LINK",
"uberLinkText": "string",
"uberTripBrandingText": "string",
"uberTripBrandingUrl": "string",
"uberTripBrandingDescription": "string",
"uberEmbedCode": "string",
"uberLink": "string",
"uberLinkRaw": "string",
"yearEstablished": "stri",
"displayLat": 0,
"displayLng": 0,
"routableLat": 0,
"routableLng": 0,
"walkableLat": 0,
"walkableLng": 0,
"pickupLat": 0,
"pickupLng": 0,
"dropoffLat": 0,
"dropoffLng": 0,
"yextDisplayLat": 0,
"yextDisplayLng": 0,
"yextRoutableLat": 0,
"yextRoutableLng": 0,
"yextWalkableLat": 0,
"yextWalkableLng": 0,
"yextPickupLat": 0,
"yextPickupLng": 0,
"yextDropoffLat": 0,
"yextDropoffLng": 0,
"emails": ["string"
],
"specialities": ["string"
],
"associations": ["string"
],
"products": ["string"
],
"services": ["string"
],
"brands": ["string"
],
"language": "string",
"languages": ["string"
],
"keywords": ["string"
],
"menusLabel": "string",
"menuIds": ["string"
],
"bioListsLabel": "string",
"bioListIds": ["string"
],
"productListsLabel": "string",
"productListIds": ["string"
],
"eventListsLabel": "string",
"eventListIds": ["string"
],
"folderId": "string",
"labelIds": ["string"
],
"customFields": {"property1": { },
"property2": { }
},
"intelligentSearchTrackingEnabled": true,
"intelligentSearchTrackingFrequency": "WEEKLY",
"locationKeywords": ["NAME"
],
"customKeywords": ["string"
],
"queryTemplates": ["KEYWORD"
],
"alternateNames": ["string"
],
"alternateWebsites": ["string"
],
"competitors": [{"name": "string",
"website": "string"
}
],
"trackingSites": ["GOOGLE_DESKTOP"
],
"isoRegionCode": "string",
"reviewBalancingURL": "string",
"firstPartyReviewPage": "string",
"isClusterPrimary": true,
"schemaTypes": ["string"
],
"attire": "UNSPECIFIED",
"priceRange": "UNSPECIFIED",
"mealsServed": ["string"
],
"locatedIn": "string",
"primaryContact": "string",
"reviewResponseConversationEnabled": true,
"holidayHoursConfirmationEnabled": true
},
"languageProfiles": [{"id": "string",
"uid": "string",
"accountId": "string",
"timestamp": 0,
"timezone": "string",
"locationType": "LOCATION",
"locationName": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"officeName": "string",
"gender": "FEMALE",
"npi": "string",
"address": "string",
"address2": "string",
"suppressAddress": true,
"displayAddress": "string",
"city": "string",
"state": "string",
"sublocality": "string",
"zip": "string",
"countryCode": "st",
"serviceArea": {"radius": 0,
"unit": "string",
"places": ["string"
]
},
"phone": "string",
"isPhoneTracked": true,
"localPhone": "string",
"alternatePhone": "string",
"faxPhone": "string",
"mobilePhone": "string",
"tollFreePhone": "string",
"ttyPhone": "string",
"categoryIds": ["string"
],
"featuredMessage": "string",
"featuredMessageUrl": "string",
"websiteUrl": "string",
"displayWebsiteUrl": "string",
"reservationUrl": "string",
"displayReservationUrl": "string",
"menuUrl": "string",
"displayMenuUrl": "string",
"orderUrl": "string",
"displayOrderUrl": "string",
"hours": "string",
"additionalHoursText": "string",
"holidayHours": [{"hours": "string",
"date": "2019-08-24",
"isRegularHours": false
}
],
"description": "stringstri",
"conditionsTreated": ["string"
],
"certifications": ["string"
],
"educationList": [{"type": "FELLOWSHIP",
"institutionName": "string",
"yearCompleted": "string"
}
],
"degrees": ["string"
],
"admittingHospitals": ["string"
],
"acceptingNewPatients": true,
"closed": {"isClosed": true
},
"paymentOptions": ["string"
],
"insuranceAccepted": ["string"
],
"logo": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"photos": [{"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
}
],
"headshot": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"videoUrls": ["string"
],
"instagramHandle": "string",
"twitterHandle": "string",
"googleWebsiteOverride": "string",
"googleCoverPhoto": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"googleProfilePhoto": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"googleAttributes": [{"id": "string",
"optionIds": ["string"
]
}
],
"facebookPageUrl": "string",
"facebookCallToAction": {"type": "NONE",
"value": "string"
},
"facebookCoverPhoto": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"facebookProfilePicture": {"url": "string",
"sourceUrl": "string",
"description": "string",
"details": "string",
"alternateText": "string",
"width": 0,
"height": 0,
"derivatives": [{"url": "string",
"width": 0,
"height": 0
}
]
},
"uberLinkType": "LINK",
"uberLinkText": "string",
"uberTripBrandingText": "string",
"uberTripBrandingUrl": "string",
"uberTripBrandingDescription": "string",
"uberEmbedCode": "string",
"uberLink": "string",
"uberLinkRaw": "string",
"yearEstablished": "stri",
"displayLat": 0,
"displayLng": 0,
"routableLat": 0,
"routableLng": 0,
"walkableLat": 0,
"walkableLng": 0,
"pickupLat": 0,
"pickupLng": 0,
"dropoffLat": 0,
"dropoffLng": 0,
"yextDisplayLat": 0,
"yextDisplayLng": 0,
"yextRoutableLat": 0,
"yextRoutableLng": 0,
"yextWalkableLat": 0,
"yextWalkableLng": 0,
"yextPickupLat": 0,
"yextPickupLng": 0,
"yextDropoffLat": 0,
"yextDropoffLng": 0,
"emails": ["string"
],
"specialities": ["string"
],
"associations": ["string"
],
"products": ["string"
],
"services": ["string"
],
"brands": ["string"
],
"language": "string",
"languages": ["string"
],
"keywords": ["string"
],
"menusLabel": "string",
"menuIds": ["string"
],
"bioListsLabel": "string",
"bioListIds": ["string"
],
"productListsLabel": "string",
"productListIds": ["string"
],
"eventListsLabel": "string",
"eventListIds": ["string"
],
"folderId": "string",
"labelIds": ["string"
],
"customFields": {"property1": { },
"property2": { }
},
"intelligentSearchTrackingEnabled": true,
"intelligentSearchTrackingFrequency": "WEEKLY",
"locationKeywords": ["NAME"
],
"customKeywords": ["string"
],
"queryTemplates": ["KEYWORD"
],
"alternateNames": ["string"
],
"alternateWebsites": ["string"
],
"competitors": [{"name": "string",
"website": "string"
}
],
"trackingSites": ["GOOGLE_DESKTOP"
],
"isoRegionCode": "string",
"reviewBalancingURL": "string",
"firstPartyReviewPage": "string",
"isClusterPrimary": true,
"schemaTypes": ["string"
],
"attire": "UNSPECIFIED",
"priceRange": "UNSPECIFIED",
"mealsServed": ["string"
],
"locatedIn": "string",
"primaryContact": "string",
"reviewResponseConversationEnabled": true,
"holidayHoursConfirmationEnabled": true
}
]
}