Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

By setting up a web hook, TimeTap can send you notifications anytime your clients or staff members book an appointment for your business.

Image RemovedImage Added


Our Notification service consists of a 3-step process:

  1.  A client or staff member books an appointment
  2.  TimeTap posts the notification with the appointment information as a JSON object to your webserver endpoint
  3.  Your webserver application processes the JSON object

Requirements:

  • A webserver running an endpoint application capable of receiving a POST request

In this guide, we'll cover the steps to:



Anchor
webserver
webserver

Webserver Requirements

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.



Return to Top


Anchor
connect
connect

Example Appointment JSON Object

When you're endpoint is setup, simply contact us to provide the URL, and we'll set up the POST.

Here's an example of what the Appointment Notification JSON object looks like:

Code Block
languagexml
titleAppointment JSON Object
linenumberstrue
	{
		"calendarid":10390617,
		"businessId":20398,
		"startTime":800,
		"endTime":845,
		"clientStartTime":800,
		"clientEndTime":845,
		"professional":{
			"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"
			},
			"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.",
			}
		}
	}