Integrating Webhooks
By setting up a web hook, TimeTap can send you notifications anytime your clients or staff members book an appointment for your business.
Our Notification service consists of a 3-step process:
A client or staff member books an appointment
TimeTap posts the notification with the appointment information as a JSON object to your webserver endpoint
Your webserver application processes the JSON object
Requirements:
A webserver running an endpoint application capable of receiving a POST request
Notes:
Any update made to an appointment will cause a webhook to get fired - not just appointment booking but also appointment editing and appointment deletion
Webhooks are specific to appointments. Any changes made to staff or client objects not involved with an appointment will not generate a webhook.
In this guide, we'll cover:
To receive a notification from TimeTap, you'll need to set up an endpoint to handle a POST request from our system. The post request will contain a JSON object (example shown below) with appointment data.
Once your endpoint is setup, provide the URL by going to Settings → Integrations in the backoffice, then scroll down to the Other Integrations section and click on the Webhook icon to expand:
With the Webhook area expanded, click the Activate Webhook button:
Enter the endpoint URL and click the "Update Webhook URL" button:
Appointment JSON Object Structure and Example
Appointment objects have several top-level properties, whose types can be viewed here: Appointment Object Values
In addition, appointment objects also have child objects for Reasons (Service or Class), Client, Staff, Location, and an Array of Custom Fields.
Here's the basic structure of an Appointment object:
{
"top-level properties" : "...",
"reason" {
Object
},
"client" {
Object
},
"staff" {
Object
},
"location" {
Object
},
"fields" {
Array
}
}Here's an abbreviated example of what the Appointment JSON object looks like:
Appointment JSON Object
{
"calendarid":10390617,
"businessId":20398,
"startTime":800,
"endTime":845,
"clientStartTime":800,
"clientEndTime":845,
"reason":{
"reasonId":96439,
"businessId":20398,
"visitMinutes":45,
"reasonDesc":"Service3"
},
"client":{
"clientId":2530974,
"firstName":"Jon",
"lastName":"Snow",
"emailAddress":"jsnow@castleblack.mil",
"city":"Victoria",
"notes":"Jon would like a notification before his appointment.",
},
"staff":{
"professionalId" : 42441,
"businessId":20398,
"userName":"DrJones2",
"email": "djones2@marshallcollege.edu"
"timeZoneCode":{
"timeZoneId":78,
"timeZoneCode":"America/New_York",
"timeZoneDesc":"America/New_York",
},
"location":{
"locationId":29945,
"locationName":"MyOffice",
"businessId":20398,
"locationType":"Office"
},
"fields": [
{
"required" : false,
"serviceIds" : [
107292
],
"userDefinedField" : false,
"dataType" : "AREA",
"active" : true,
"code" : "UDF",
"visibleOnScheduler" : true,
"validationRegex" : null,
"sortOrder" : 21,
"businessId" : 23144,
"hint" : null,
"filterByService" : true,
"oldFieldIds" : null,
"createdUser" : "mpbtest138",
"labelTag" : "%CUSTOM_FIELD_107740_LABEL%",
"modifiedDate" : 1488575155000,
"tagName" : null,
"modifiedUser" : "MPBTEST138",
"label" : "Comments",
"createdDate" : 1488394066000,
"value" : "These are comments ",
"extendedValue" : "These are comments ",
"validationError" : null,
"fieldValues" : null,
"visible" : true,
"schedulerPreferenceFieldDefnId" : 107740,
"mode" : "APPT",
"valueTag" : "%CUSTOM_FIELD_107740%"
},
{
"required" : null,
"serviceIds" : null,
"userDefinedField" : true,
"dataType" : "TXT",
"active" : true,
"code" : "UDF",
"visibleOnScheduler" : true,
"validationRegex" : null,
"sortOrder" : 22,
"businessId" : 23144,
"hint" : null,
"filterByService" : false,
"oldFieldIds" : null,
"createdUser" : "MPBTEST138",
"labelTag" : "%CUSTOM_FIELD_108594_LABEL%",
"modifiedDate" : 1488575322000,
"tagName" : null,
"modifiedUser" : "MPBTEST138",
"label" : "My Custom Field",
"createdDate" : 1488575322000,
"value" : "Custom field value",
"extendedValue" : "Custom field value",
"validationError" : null,
"fieldValues" : null,
"visible" : true,
"schedulerPreferenceFieldDefnId" : 108594,
"mode" : "APPT",
"valueTag" : "%CUSTOM_FIELD_108594%"
}
],
}