Online Submissions
Online Submissions are scheduling events that allow SocialClimb to connect prospective patient calls and online submissions to confirmed appointments.
The SocialClimb API allows you to post online submissions to be included in marketing reporting. To use these endpoints you will need a Web Forms API token found https://app.socialclimb.com/app/settings/web-forms. The API token must be placed under the HTTP Request Header api-token.
The following table outlines the fields that make up the online submission data structure. Some fields are required, others are optional.
| Name | Type | Required | Description |
|---|---|---|---|
| submission_date | string | Yes | A string representation of a UTC timestamp of when the online submission was received by the scheduling system. Follows the ISO 8601 Standard. (YYYY-MM-DDThh:mm:ss.sTZD) Time zones will be converted to UTC Time. Will be used to match the appointment to the online submission, as well as in reporting. |
| scct_parameter | string | Yes | A SocialClimb campaign tracking ID. The SCCT parameter is used to tie the online submission to a specific marketing campaign. When a prospect schedules an appointment, the SCCT will need to be captured and sent to us on this request. See the note below about capturing the SCCT parameter. |
| phone_number | string | Yes | The phone number of the scheduled patient/prospect. Used to match the appointment to the online submission for reporting purposes. |
| conversion_type | string | Yes | Enum: Online, App. Indicates the source of the online submission, such as an online tool, or an app that helps a prospective patient find a doctor. Will be used to differentiate sources in the reporting. |
| patient_name | string | Yes | The name of the scheduled patient/prospect. Used to match the appointment to the online submission for reporting purposes. |
| patient_id | string | No | The ID of the patient/prospect that is used in your practice management or other software. Helps with matching the appointment to the online submission for reporting purposes, but is not required. |
| scheduled_appointment_date | string | No | The date of the scheduled appointment |
| string | No | The email of the scheduled patient/prospect. Helps with matching the appointment to the online submission for reporting purposes, but is not required. | |
| street | string | No | The street address of the scheduled patient/prospect. Helps with matching the appointment to the online submission for reporting purposes, but is not required. |
| secondary_street | string | No | A secondary address such as an apartment or unit number. Helps with matching the appointment to the online submission for reporting purposes, but is not required. |
| city | string | No | The city part of the patient/prospect’s address. Helps with matching the appointment to the online submission for reporting purposes, but is not required. |
| state | string | No | A two letter abbreviation of the state in the patient/prospect’s address. Helps with matching the appointment to the online submission for reporting purposes, but is not required. |
| postal | string | No | The zip code for the patient/prospect’s address. Helps with matching the appointment to the online submission for reporting purposes, but is not required. |
| is_test | boolean | No | Used to indicate that the submission is a test. Test submissions will not be included in reporting. Test submissions are deleted every night. Defaults to false |
*The submission_date is only required when using the /bulk-upload endpoint.
The SocialClimb campaign tracking script can append the SCCT parameter to any URL that sends users to an online scheduling tool. To enable this feature, go to the Campaign Tracking Setup page in the settings of the SocialClimb app, and click to enable Link Tracking. It will then allow you to enter any URL that you want the SCCT appended to. It will then add a URL parameter to any URL which you specified. It should then be captured on your site or scheduling tool.
For example, if you enter https://www.example.com under the Link Tracking setting, when a user clicks a link to example.com on your site where the tracking script is installed, the URL will have the SCCT parameter appended in a URL parameter under the key ‘scct’.
The URL in this case would be something like https://www.example.com?scct=<scct_parameter>. The online tool should then capture the SCCT parameter so that it can be used for online submissions.
This endpoint allows you to post a single online submission.
POST /v1/online-submissions/upload
The following JSON body represents a single online submission:
{
"submission_date": "2023-09-20T12:00:00Z",
"scct_parameter": "98302",
"phone_number": "1112223333",
"conversion_type": "Online",
"patient_name": "Joe Black",
"patient_id": "1234567",
"scheduled_appointment_date": "2023-12-23T12:00:00Z",
"email": "example@example.com",
"street": "123 Address Street",
"secondary_street": "Unit 2",
"city": "Example City",
"state": "NY",
"postal": "10001",
"is_test": true
}
This endpoint is similar to the previous one, but allows for the upload of multiple online submissions. The body contains a list of single submissions.
POST /v1/online-submissions/bulk-upload
{
"submissions": [
{
"submission_date": "2023-09-20T12:00:00Z",
"scct_parameter": "98302",
"phone_number": "1112223333",
"conversion_type": "Online",
"patient_name": "Joe Black",
"patient_id": "1234567",
"scheduled_appointment_date": "2023-12-23T12:00:00Z",
"email": "example@example.com",
"street": "123 Address Street",
"secondary_street": "Unit 2",
"city": "Example City",
"state": "NY",
"postal": "10001",
"is_test": true
},
{
"submission_date": "2023-09-21T12:00:00Z",
"scct_parameter": "20389",
"phone_number": "4445556666",
"conversion_type": "App",
"patient_name": "Steve White",
"patient_id": "7654321",
"scheduled_appointment_date": "2023-12-23T12:00:00Z",
"email": "example2@example.com",
"street": "456 Address Street",
"secondary_street": "Unit 3",
"city": "Example Town",
"state": "NY",
"postal": "10001",
"is_test": true
}
]
}