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

Open

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:

Open

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:

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

Appointment JSON Object

Object Values

Reason Object 

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

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

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: