Skip to main content

Variable List for Notes

Notes, Descriptions, Summaries. A complete list of various options that are available within workflow note sections.

Written by Johannah Strobaugh

The complete list of variables that TimeZest can insert into a note is the following:

  • Account Name - account.name - The name of your TimeZest account- i.e. "FipTech"

  • Appointment Duration - appointment.duration - The duration of the appointment meeting.

  • Appointment External Name - appointment.external_name - The external name for the appointment, as configured in the appointment type.

  • Appointment Internal Name - appointment.internal_name - The internal name for the appointment, as configured in the appointment type.

  • Appointment Start Time (Client Time Zone) - appointment.start_time_client - The time the customer has selected for their appointment, formatted as a long string, e.g. "1:30 pm on Wednesday, July 7, 2022 (Eastern Time (US & Canada))". This time will be in the time zone used by the client when they scheduled their appointment.

  • Appointment Start Time (Scheduled User Time Zone) - appointment.start_time_technician - The time the customer has selected for their appointment, formatted as a long string, e.g. "1:30 pm on Wednesday, July 7, 2022 (Eastern Time (US & Canada))". This time will be in the time zone configured for the first scheduled user.

  • Cancellation Reason - appointment.cancellation_reason - The cancellation reason, if given, when an appointment has been canceled by a client.

  • Client Company Name - company.name - The name of the client's company.

  • Client Email Address - client.email - The client's email address.

  • Client First Name - client.first_name - The first name of the client.

  • Client Full Name - client.name - The full name of the client.

  • Client Last Name - client.last_name - The last name of the client.

  • Client Phone Number - client.phone_number - The phone number given by the client when scheduling.

  • Client Phone Type - client.phone_type - The phone number type selected by the client when scheduling

  • Client Time Zone - client.time_zone - The time zone used by the client when scheduling their appointment.

  • Closed Loop Ticket Number - ticket.closed_loop_number - The service ticket's number in text format.

  • Issue Description - appointment.issue_description - The Summary line of the ticket.

  • Link to Ticket in PSA - ticket.link - The HTML output of the link to the service ticket.

  • Online Meeting Client URL - online_meeting.join_url - The URL that the client should use to join the online meeting for an appointment if one has been created.

  • Online Meeting Password - online_meeting.password - The password needed to join the online meeting, if one has been created.

  • Online Meeting Technician URL - online_meeting.start_url - The URL that the technician should use to join the online meeting for an appointment if one has been created.

  • Online Meeting Type - online_meeting.type - A string indicating the type of online meeting - either "Zoom" or "Microsoft Teams".

  • Person Who Rescheduled (Client or Technician) - appointment.rescheduler - Indicates who rescheduled the appointment whether the end user (your client) or someone on your team rescheduled via Calendar HQ.

  • Rescheduling URL - appointment.rescheduling_url - The URL a client can use to reschedule if rescheduling is permitted.

  • Resource Names - appointment.resource_names - the names of the resources for the appointment, joined into a sentence.

  • Scheduled User Email Addresses - appointment.scheduled_user_emails - The email addresses of the scheduled users.

  • Scheduled User Names - appointment.scheduled_user_names - The names of the scheduled users, joined into a sentence.

  • Scheduling URL - appointment.scheduling_url - The URL the client can use to schedule their appointment.

  • Teams Dial-in Number - online_meeting.dial_in_number - The scheduled user's Microsoft Teams Meeting dial-in number. This allows all parties to call in to the Teams meeting.

  • Teams Phone Conference ID - online_meeting.conference_id - The scheduled user's Microsoft Teams Meeting conference ID. This allows all parties to join the meeting after calling in.

  • Ticket Number - ticket.number - The number of the ticket associated with a scheduling request, if one is associated.

  • Ticket Summary - ticket.summary - The summary of the ticket associated with a scheduling request.

  • Ticket URL - ticket.url - The URL that a technician can use to access the corresponding ticket if one exists.


Did this answer your question?