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:

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

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 Object Relational Structure 

 

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 } }

Appointment JSON Object Example

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

Object Values

Reason Object 

Client Object 

Client objects contain top-level properties, as well as a nested array of Custom Fields.

Client object value types can be found here: Client Object Value Types

"client" : { "excludeEmailCategoryIdList" : null, "viewClientAccountIds" : null, "lastName" : "Smith", "clientAccountId" : null, "createdDate" : null, "country" : null, "modifiedUser" : "MPBTEST138", "state" : null, "locale" : null, "firstName" : "Josh ", "cellPhone" : "9802221111", "ssn" : null, "timeZone" : { "visible" : null, "timeZoneCode" : "America\/New_York", "timeZoneDesc" : "America\/New_York", "sortOrder" : 10, "timeZoneId" : 78 }, "allowWaitListText" : null, "salesforceContactId" : null, "createdUser" : "MPBTEST138", "sex" : null, "modifiedDate" : 1488575701889, "address2" : null, "fullName" : "Josh Smith", "status" : "Active", "city" : null, "zip" : null, "fields" : [ { "required" : true, "serviceIds" : null, "userDefinedField" : false, "dataType" : "TXT", "active" : true, "code" : "firstName", "visibleOnScheduler" : true, "validationRegex" : null, "sortOrder" : 0, "businessId" : 23144, "hint" : null, "filterByService" : false, "oldFieldIds" : null, "createdUser" : "mpbtest138", "labelTag" : "%CLIENT_FIRSTNAME_LABEL%", "modifiedDate" : 1488394066000, "tagName" : "CLIENT_FIRSTNAME", "modifiedUser" : "mpbtest138", "label" : "First Name", "createdDate" : 1488394066000, "value" : "Josh ", "extendedValue" : "Josh ", "validationError" : null, "fieldValues" : null, "visible" : true, "schedulerPreferenceFieldDefnId" : 107719, "mode" : "CLIENT", "valueTag" : "%CLIENT_FIRSTNAME%" }, { "required" : true, "serviceIds" : null, "userDefinedField" : false, "dataType" : "TXT", "active" : true, "code" : "lastName", "visibleOnScheduler" : true, "validationRegex" : null, "sortOrder" : 1, "businessId" : 23144, "hint" : null, "filterByService" : false, "oldFieldIds" : null, "createdUser" : "mpbtest138", "labelTag" : "%CLIENT_LASTNAME_LABEL%", "modifiedDate" : 1488394066000, "tagName" : "CLIENT_LASTNAME", "modifiedUser" : "mpbtest138", "label" : "Last Name", "createdDate" : 1488394066000, "value" : "Smith", "extendedValue" : "Smith", "validationError" : null, "fieldValues" : null, "visible" : true, "schedulerPreferenceFieldDefnId" : 107720, "mode" : "CLIENT", "valueTag" : "%CLIENT_LASTNAME%" }, { "required" : true, "serviceIds" : null, "userDefinedField" : false, "dataType" : "TXT", "active" : true, "code" : "fullName", "visibleOnScheduler" : false, "validationRegex" : null, "sortOrder" : 2, "businessId" : 23144, "hint" : null, "filterByService" : false, "oldFieldIds" : null, "createdUser" : "mpbtest138", "labelTag" : "%CLIENT_FULLNAME_LABEL%", "modifiedDate" : 1488394066000, "tagName" : "CLIENT_FULLNAME", "modifiedUser" : "mpbtest138", "label" : "Full Name", "createdDate" : 1488394066000, "value" : "Josh Smith", "extendedValue" : "Josh Smith", "validationError" : null, "fieldValues" : null, "visible" : false, "schedulerPreferenceFieldDefnId" : 107721, "mode" : "CLIENT", "valueTag" : "%CLIENT_FULLNAME%" }, ], "homePhone" : "7048882233", "clientId" : 3042662, "stripeCustomerId" : null, "squareCustomerId" : null, "address1" : null, "notes" : null, "password" : null, "emailAddress" : "timetaptest@gmail.com", "language" : null, "companyName" : null, "county" : null, "dateOfBirth" : null }

Staff Object 

Staff object value types can be found here: Staff Object Value Types

Location Object 

Location object value types can be found here: Location Object Value Types

Custom Fields Object 

Custom Field Value Types: