Workiz
The Workiz integration creates a lead in your Workiz account for NZ Leads leads, with the customer’s contact info and postal code, and keeps that Workiz lead up to date.
You set Workiz up once and then choose where it’s used: which businesses, sources, and voice agents send leads to it. Add it from a source’s Messaging Settings → Integrations tab, or from Settings → Integrations in the menu, which lists all your integrations.
What gets synced
Every lead pushed into Workiz includes:
- First name
- Last name
- Phone number
- Postal code
When leads reach Workiz
- When the customer shares a phone number or email, if CRMs is ticked under Trigger integrations: in the source’s Contact Info tab for that kind of contact info.
- After a voice-agent call with the lead.
A new lead that hasn’t shared contact info isn’t sent. Later updates for the same lead go to the same Workiz lead.
Connecting Workiz
Add Workiz
In NZ Leads, open the source → Messaging Settings → Integrations tab. If the tab shows Business Settings Active, switch on Customize for Location first. Then click Add integration → Create new → Workiz. The Workiz window opens. If your account already has a Workiz integration, pick it on the Use existing tab instead.
Get your API token and API secret from Workiz
The card lists the steps: open the Workiz Developer API page in your Workiz account (the card links to it), enable the Developer API, go to Developer API Settings, and generate API credentials. Workiz uses two credentials together: an API token and an API secret. They are not interchangeable.
Save them
Paste the token into Enter your API TOKEN and the secret into Enter your API SECRET, then click Save API Credentials. NZ Leads checks them with Workiz first: it creates a test lead named Integration Test and marks it lost. If they don’t work, nothing is saved and the card still shows Connect Workiz.
Turn on Enabled
The card now shows Workiz Integration with the Enabled switch off. Turn it on. Nothing is sent to Workiz until it’s on.
Choose where it’s used
Workiz added from a source’s Integrations tab is already on for that source, unless the source already uses another Workiz integration. To use it for other sources, tick them under Where it’s used in the Workiz window, then click Done.
To add this Workiz integration to another source later, open that source’s Integrations tab → Add integration → Use existing and pick it. A source sends to one Workiz integration at a time: turning on another one there replaces the current one after you confirm. Ticking a business under Where it’s used turns Workiz on for that business’s sources, including future ones. Sources follow their business unless they choose differently on their own Integrations tab.
In Settings → Integrations, Add integration → Workiz adds the integration to the business selected in the sidebar and opens its window. Tick the places that should use it under Where it’s used.
Options
Enabled
Turns this Workiz integration on or off everywhere it’s used. It’s off after you save the credentials. To stop sending one source’s leads only, switch Workiz off on that source’s Integrations tab instead.
Checking or changing the credentials
The saved token is shown in a row on the card. Expand the row:
- Press to validate API token checks both credentials with Workiz, with another Integration Test lead that is marked lost.
- The delete icon, then Yes, removes both the API token and the API secret. Workiz gets nothing until you save new credentials. The integration stays where it’s used.
Matching and deduplication
NZ Leads doesn’t search Workiz for an existing lead. It creates one Workiz lead per lead, remembers it, and updates that Workiz lead later.
A note on appointment booking
Workiz can also be where the voice agent books jobs during a call. AI text conversations can’t book in Workiz. That’s a separate setting with its own Workiz API key, not the API token and secret above: choose Workiz under Appointment Scheduling in a voice agent’s Appointments section, then pick the job types and the appointment duration, and add arrival windows or a job source if you need them. See Voice Agent Scheduling Integrations. This page covers only the Workiz leads created from NZ Leads leads.
Turning Workiz off
- For one source - untick the source under Where it’s used in the Workiz window, or switch Workiz off on that source’s Integrations tab. If the tab shows Business Settings Active, switch on Customize for Location first. Other sources keep sending.
- Everywhere - turn off Enabled on the Workiz card, or click Delete integration in the Workiz window. Every source that used it stops sending to Workiz.
Leads already in Workiz stay there.
Troubleshooting
- The credentials aren’t saved - One of the two fields is wrong, or you pasted them into the wrong spots. Double-check the API token vs the API secret.
- “Not set up yet” next to Workiz on a source’s Integrations tab - Enabled is off. Click Settings and turn it on.
- No leads appearing in Workiz - Confirm Enabled is on and that Workiz is on for the source. Workiz gets a lead only after the customer shares contact info (with CRMs ticked in Contact Info) or after a voice-agent call. Also make sure the Workiz API user has permission to create leads.
- Leads missing postal code - The postal code is sent only when NZ Leads has one for the lead.
- Integration Test leads in Workiz - NZ Leads creates one each time it checks your credentials, and marks it lost.
- A warning icon at the top of the card - Workiz refused a new lead, and the integration shows Has errors in your integrations list. Click the icon to read the errors from the last 7 days, and Clear Errors once you’ve fixed the cause.
Questions about the Workiz integration? Email support@nzleads.com.