Skip to main content
Who it’s for:Project LeadAdmin
Available on:Web
Once Workiz is connected to your account, TrueRestore checks Workiz every few minutes and creates jobs from it automatically.

​
Connecting Workiz

Admins connect Workiz in Settings → Integrations → Workiz:
  1. Copy the API key from your Workiz account. It starts with api_, and your Workiz plan needs the Developer API add-on.
  2. Click Connect, paste the key, and click Connect. TrueRestore checks the key with Workiz before saving it, and tells you if Workiz rejects it.
  3. Jobs and tagged leads start coming in within a few minutes.
To use a different key, for example after regenerating it in Workiz, click Edit and paste the new key; leave it blank to keep the current one. Your skip words and other settings stay as they are. To stop importing, click Disconnect: jobs already imported stay in TrueRestore.

​
What gets imported

The lead tag is matched loosely: upper or lower case, spaces, and punctuation don’t matter, so “True Restore” works too. A tagged lead is imported whatever its job type is.

​
Job types that aren’t imported

When Skip jobs by job type is on (Settings → Integrations → Workiz), a Workiz job isn’t imported if its job type contains any of its words, anywhere in its name, ignoring upper and lower case. Unless your company has changed it, the list is clean, upholstery, rug, pet, odor, carpet. For example, “Water Damage Cleanup” is skipped because it contains “clean”. Admins can change the list there: type a word and press Enter to add it (or paste several separated by commas), click the × on a word to remove it, or turn the switch off to import every job type. Only the job type is checked, and leads tagged for import are always imported. Changes apply from the next check; jobs skipped earlier are picked up only while they’re still open and recent.

​
What comes across

The client’s name, email, phone, and company, the property address, the Workiz job type, and the Workiz job date, which becomes the job’s date of loss and start date. Where a Workiz record is missing a detail or has one TrueRestore can’t use, such as an incomplete email or a missing city, state, or ZIP code, the job is created with a placeholder instead. Check the address and client details on imported jobs and correct anything that’s wrong. Each Workiz record is imported once, so later checks don’t create duplicates. Changes made in Workiz after a job is imported aren’t copied across, so make them on the TrueRestore job directly.

​
Checking that Workiz is working

Admins can see how the Workiz import is doing in Settings → Integrations → Workiz:
  • The tag next to Workiz says Connected while imports are working, or Not importing when they’ve stopped.
  • The line under it checks the connection each time you open the page. Show details says what’s wrong, and Check again re-runs the check.
  • Last synced is when the last successful import finished. It normally updates every few minutes; a check that fails doesn’t move it, and the reason shows in red instead.
  • A red Job import failing since… message gives the reason the last import couldn’t run, for example when Workiz rejects the key TrueRestore uses for your account.
  • A yellow No Workiz import has finished since… message means no import has finished for over an hour.
If the page says Workiz rejected the key, click Edit and enter the current key from Workiz. If the import can’t sign in to TrueRestore, click Edit and Save with the key left blank: that gives the import TrueRestore’s current key. If Workiz isn’t responding, the import tries again every 5 minutes on its own.

​
If a Workiz job doesn’t appear

  1. Check the Workiz card in Settings → Integrations. If it says Not importing, or shows No Workiz import has finished since… (which can appear while it still says Connected), follow that message and what Show details says. Otherwise give it a few minutes: new records are picked up on the next check.
  2. Make sure it’s open in Workiz. Closed jobs and leads aren’t imported.
  3. For a job, check its job type. If it contains one of the words in Skip jobs by job type, remove that word in Settings → Integrations, or rename the job type in Workiz. It’s picked up on a later check as long as it’s still open and recent.
  4. For a lead, check its tags. Add TrueRestore to the lead’s tags in Workiz. Older leads aren’t picked up, even once tagged.
  5. Search the Jobs list, and clear any filters. A record with missing details may have come across under a placeholder client name. See Finding and filtering jobs.
  6. Still not there? Create the job yourself. See Creating a new job.
When you contact Support, include the Workiz job or lead ID, its job type and tags, and when it was created or last changed in Workiz.