Tulip Appointments and Timekit
Timekit is a set of APIs used to manage bookings, availability and more. Appointments is built on top of Timekit and designed to use Timekit out of the box without any hidden features. This allows retailers to heavily customize the experience they create for their customers by using the extra features that Timekit offers.
When you use Appointments, your API is the standard Timekit API. The Tulip Cloud only stores the provided Timekit API Key and it only interacts with Timekit using the standard Timekit API. You can manage API connectivity and webhooks directly from your Timekit account. All Tulip Appointments data is stored inside Timekit, including configuration data.
You can also connect Timekit to Zapier in order to easily connect Timekit to many external services, such as email, reporting, CRM, and more.
Learn more about the Timekit API and endpoints here.
Timekit entities integration
Each concept in Tulip Appointments maps to core concepts in Timekit. The table below shows how each Appointments concept maps to Timekit.
Tulip Appointments | Timekit Concept | Note |
Employee | Project + Resource | One Employee Project is created per employee. Employee projects are not bookable via the widget, One Employee Resource is also created per employee |
Store | Project (hidden) | One hidden project is created per store that stores configuration |
Appointment Type | Project | Each appointment type per store is created in the Tulip Admin Console |
Store Capacity | Resources | (non people) Resources are created per store to define store capacity |
Timekit metadata
Tulip expands upon Timekit and uses Timekit metadata to layer on additional retail-specific functionality such as being able to select a store and see available appointments.
If you want to expand upon Tulip Appointments you can access the Timekit API to manage metadata and customize how the widget filters data and interacts with Timekit.
The table below lists the metadata that Tulip adds to projects. When extending or changing the application, it’s important to keep the metadata in the same format. You can add to the metadata to add new data fields or options to projects. Tulip metadata is prefixed witht_
to keep it separate from other metadata that you may be storing.
metadata title | Description | Required or Optional |
t_project_type | (Used by Tulip only) | Optional |
t_region | ISO Country ID | Optional |
t_store_name | Name of Store | Required |
t_store_id | ID of Store | Required |
t_store_address | Address of Store | Optional |
t_store_city | City Name | Optional |
t_store_phone | Store Phone # | Optional |
t_appointment_type_name | e.g. “30 Min Fitting” | Required |
t_appointment_type_description | Longer description | Optional |
t_appointment_type_image | Optional Image | Optional |