Scheduling Integrations
Your voice agent can check availability and book appointments during a live call. Turn on Appointment Scheduling and choose where the bookings go.
Getting here
In NZ Leads, open Voice Agents → Agents → Edit on an agent → Appointments, and check Appointment Scheduling. It is off by default.
Appointments and Integrations are two different sections of the agent editor. This page covers Appointments (booking). For CRM and messenger connections (HubSpot, Slack, SMS, and so on), see Voice Agent Integrations.
Choosing a Scheduling Service
Job Scheduler is selected by default. The other options are Google Calendar, Microsoft Outlook, Cal.com, LeadConnector, Housecall Pro, ServiceTitan, FieldPulse, Quickbase, and Workiz. Workiz is available for voice agents only.
Job Scheduler
NZ Leads’s own Jobs calendars. No external account is needed. Choose a Scheduling mode:
- Strict - books on a calendar whose available hours and booking rules are set in the calendar itself. Pick it under Calendar.
- AI - books on an AI calendar that follows your written AI scheduling instructions. The instructions are saved on that calendar in Jobs. Under Calendar, choose an existing AI calendar or Create new one.
Click Set up calendar to create a calendar without leaving the agent. In AI mode, Notify me when an appointment is scheduled sends the booking details to your enabled messenger integrations; the appointment is always saved in Jobs.
See Calendar setup and Jobs.
Google Calendar
- Click Connect Google Account. Bookings go to that account’s primary calendar. Disconnect removes the account. The account is connected per business, so choose the agent’s Business in General first.
- Appointment Duration (minutes) - required, at least 5. The length of each bookable slot.
- Working Hours - appointments are offered only inside these hours, in the agent’s Calling hours → Timezone. Any time means no limit.
- Buffer Between Appointments (minutes) - free time kept before and after every busy event in the calendar, for example to drive to the next job.
- Scheduling Instructions - required. When bookings are allowed, including day-specific exceptions or preferred times.
The agent offers only times inside your working hours that are free in the calendar, with the buffer around busy events.
Microsoft Outlook
The same as Google Calendar: click Connect Microsoft Account, then set Appointment Duration (minutes), Working Hours, Buffer Between Appointments (minutes), and Scheduling Instructions. Bookings go to that account’s calendar.
Cal.com
- Cal.com API Key - an API key with access to your Cal.com event.
- Event Type ID - the Cal.com event type the agent books.
There is no separate timezone field: the agent’s Calling hours → Timezone is used. The agent fills the event’s booking questions with the customer’s details; set those questions in Cal.com under Event Types → your event → Advanced → Booking Questions.
LeadConnector
GoHighLevel’s calendar. Requires the GHL Unlimited package.
- GoHighLevel API Key
- Calendar ID
- Location ID (Sub-Account ID)
Housecall Pro
- Housecall Pro API Key - in Housecall Pro under Settings → Integrations → API key.
- Click Load employees, then choose a Default assignee. Availability is checked for that employee and new jobs are assigned to them. Housecall Pro default (no explicit assignee) leaves the choice to Housecall Pro.
The agent’s Calling hours → Timezone is used for Housecall Pro times.
ServiceTitan
The agent checks ServiceTitan Dispatch Capacity for open times and creates a booking request in ServiceTitan. Ask your ServiceTitan admin for:
- Client ID and Client Secret of the connected ServiceTitan API application
- App Key from the ServiceTitan Developer Portal app
- Tenant ID (ServiceTitan Settings → Integrations → API Application Access)
- Booking Provider ID
- Business Unit ID - the business unit that receives the booking requests
- Job Type ID - the job type used for bookings
- Campaign ID (optional) - the campaign or source attached to the booking requests
FieldPulse
- FieldPulse API Key
- Company ID
Quickbase
Book into your own Quickbase appointments table:
- Appointments table link - open the table in Quickbase and copy the browser URL.
- User token - a Quickbase user token assigned to the app that holds the table.
- Click Connect. NZ Leads picks the start, end or length, status, and customer detail fields automatically; click Edit to change them.
- Set the Appointment length (minutes) and Working Hours. The agent offers only times inside your working hours that don’t overlap appointments already in the table.
- Click Test & preview open times to see how many existing appointments were found and the next open times.
See Book appointments in Quickbase for the advanced options.
Workiz
Free times come from your Workiz account’s booking settings and your technicians’ hours, and the agent books the job straight into Workiz.
- Workiz API Key - not the same as the API token and secret of the Workiz lead integration.
- Click Load from Workiz to fill the lists below from your Workiz account.
- Default Job Type - required. Set on a new job when the agent doesn’t pick one.
- Job Types the Agent Can Choose - the agent picks the one that fits the customer and looks for times with the technicians who do it. With fewer than two selected, it always books the default job type.
- Appointment Duration - required. The length of each time slot and of the booked job.
- Arrival Window Start Times (optional) - the agent offers only windows starting at these times, each as long as the appointment duration, when Workiz has room for the whole window. Leave empty to offer Workiz’s own time slots.
- Jobs per time slot - how many jobs one time slot can hold. Leave blank to use your Workiz account’s setting.
- Job Source (optional) - set on every new job.
- Scheduling Instructions - required.
Checking the connection
Saving the agent doesn’t test the credentials, so double-check them before going live. A booking that fails during a call shows as a warning icon next to Appointment Scheduling; click it to see the errors from the last 7 days. For Quickbase, use Test & preview open times. Load employees (Housecall Pro) and Load from Workiz also use your API key, so an error there points to the key.
When credentials change (an API key is rotated, an employee leaves), update them here. An expired key means bookings fail during calls.
Information to Collect
Before booking, the agent asks for the checked fields one at a time and skips anything it already knows. Each row has a checkbox and a name of up to 100 characters; click Add Field for more.
Defaults (all checked): Customer Name, Service Address, Phone Number.
The list is hidden for Job Scheduler and Cal.com. Job Scheduler uses its calendar’s Information to collect, and Cal.com uses the booking questions of your event. With Appointment Scheduling off, an Office Agent still collects these fields and passes them to your team.
Appointment Summary
How the agent confirms the booking. Shown when Appointment Scheduling is on; checked by default.
- Max length: 500 characters.
- Default:
You're all set! {{day}} at {{time}}. - Placeholders:
{{day}},{{time}},{{address}},{{service}},{{phone}}.
The agent always confirms the booked day and time as the booking returned them. If your template says goodbye, the agent ends the call with it.
Examples:
You're booked for {{day}} at {{time}}. We'll see you at {{address}}.Great, I've got you down for {{day}} at {{time}}.
What happens during a booked call
Customer agrees to book
The agent offers times from your Scheduling Service.
Agent collects the details
The agent asks only for the details it doesn’t already have. On calls to leads it often already knows the name and phone number.
Appointment is created
- Job Scheduler - a scheduled Job on the selected calendar. Open CRM → Jobs to review it.
- Google Calendar / Microsoft Outlook - an event in the connected calendar.
- Cal.com / LeadConnector / Housecall Pro / FieldPulse / Workiz - the appointment or job is created in that system.
- ServiceTitan - a booking request in ServiceTitan.
- Quickbase - a new record in your appointments table.
Agent confirms
The agent confirms the day and time, using your Appointment Summary template when it’s on, then closes the call.
Troubleshooting
No calendar is available in Job Scheduler.
- Click Set up calendar, or open CRM → Jobs and create a calendar for the same business as the agent.
- The Calendar list shows only calendars of the selected mode (AI or Strict).
Bookings fail during calls.
- Click the warning icon next to Appointment Scheduling to see the error.
- Re-check the API key and the IDs (Event Type, Calendar, Location, Company, Business Unit, Job Type). They must come from the same account as the key.
The agent offers times that don’t match the calendar.
- Check the agent’s Calling hours → Timezone. Every service except Job Scheduler uses it; Job Scheduler uses its calendar’s timezone.
- For Google Calendar and Outlook, check Working Hours and Buffer Between Appointments (minutes).
Questions? Email support@nzleads.com.