If you are leveraging an external system for lead capture and want to automatically sync that lead data to Prospyr, you can leverage our incoming Webhook system.
To get started, reach out to Prospyr support and we will provide you with a unique Webhook Endpoint and Token.
Once you've got those, you can start making POST requests to your Webhook Endpoint with a JSON body that looks like the following:
{
"type": "lead.create",
"payload": {
"firstName": "Hook",
"lastName": "Em",
"email": "[email protected]",
"note": "Loves chocolate"
}
}
Currently we just support the lead.create payload type, but we are actively adding other objects that can be pushed into Prospyr - please let support know your requests around new objects.
Lead Creation supported payload fields
Field | Type | Description |
firstName | String (required) | Patient first name |
lastName | String (required) | Patient last name |
String (required) | Patient email | |
phoneNumber | String | Patient phone number |
tags | Array of Strings | A list of tags you want to add to this Lead |
note | String | A general use field to attach data to a Lead |
source | String | An optional field to mark the source of a Lead |
photoUrls | Array of Strings | Optional list of image urls that we will add to the patient chart |
primaryLocation | String | Optional name of Location for lead |
documentUrls | Array of Strings | Optional list of document urls that we will add to the patient chart Documents tab |
serviceCategoriesOfInterest | String | Comma delimited list of service categories a lead is interested in, the names of the categories should match what practice has configured in their catalog - otherwise they will not display. |