Articles on: CRM Integrations

How to Connect LeadTruffle to Workiz

📝 Generate your Workiz API credentials and add them to LeadTruffle to connect the two accounts.



Table of contents





What you'll need


  • Admin access to your Workiz account (or someone who can turn on the Account Settings permission for you)
  • Admin access to your LeadTruffle account


The credentials depend on your Workiz API version: API v2 needs only an API key; API v1 needs an API Token and API Secret. LeadTruffle detects the version when you enter the key and shows API v1 or API v2. Existing v1 connections remain supported until you choose to replace their credentials.


API v2 and required custom fields


API v2 is recommended for the full Workiz job-type and lead-source lists and optional native availability. You do not need an API secret or a second availability key for v2.


If you want the AI to book jobs with v2:


  1. Give the key Read & Write access to Jobs and Leads for the actions you enable. Allow Read access to Users, Job Types, Ad groups, Search and Availability for those features, plus Custom Fields to check job requirements.
  2. In Workiz Settings → Basic Settings, load Workiz options and choose your booking job type.
  3. Open Custom fields and load the fields using your entered key. Set a fixed default for every applicable field marked Required to create. Fields marked only Required to close can be completed later in Workiz. Save the key and defaults together; you do not need to save the connection first.


Requirements depend on your Workiz account and sometimes the job type. V2 can reject a job for missing required fields even if earlier v1 bookings worked without them. The defaults apply only to new AI-booked Jobs, not ordinary Lead sync or existing records; they do not ask customers for a different answer each time.


If required fields stop a connection from saving, complete them in Custom fields and save again. The settings stay open after a validation error. Entering a different API key clears the old defaults from the draft; choose new defaults for that connection before saving. Reload Custom fields and save again if requirements change in Workiz. File uploads and unsupported field types cannot be supplied as defaults.


See the Workiz AI booking guide for supported fields and scheduling options.




Step 1: Enable the Developer API add-on in Workiz


Before you can generate credentials, you need to turn on the Developer API add-on in Workiz.


  1. From the Workiz navigation bar, select the Feature Center.
  2. Select Developer API.
  3. Select Get started to enable the add-on.


Not seeing the Feature Center? You may not have the right permissions. Ask your account admin to turn on the Account Settings permission for your user type from the Roles & Permissions page.




Step 2: Get your Workiz API credentials


  1. From the Workiz navigation bar, select the profile icon → Settings.
  2. Under Integrations, select Developer.
  3. For API v2, copy your API key and allow the permissions listed above. For API v1, copy your API Token and API Secret using the copy icon next to each. The screenshot below shows the legacy v1 credentials.




A legacy API Token may look like this. Let LeadTruffle detect the version rather than relying on the key's appearance:


api_xxxxxxxxxxxxxxxxxxxxxxxxxxxx


Keep your API key and any API secret private. Treat them like passwords; a v2 API key can grant account access on its own.


Not seeing the Developer settings page? As in Step 1, this usually means a permissions issue. Have your admin enable the Account Settings permission from the Roles & Permissions page.




Step 3: Add your credentials to LeadTruffle


  1. In LeadTruffle, open the Workiz integration settings.
  2. Paste your Workiz key or legacy token into Workiz API key and wait for the version check.
  3. If API v1 is detected, also enter your API Secret. For API v2, no secret is needed.
  4. Enable the integration and save. If you will use v2 AI booking, complete the Custom fields setup above. The screenshot below shows the older v1 form.




That's it — LeadTruffle is now connected to your Workiz account.



What's next


With Workiz connected, you can:





Troubleshooting


Problem

What to check

Can't find Feature Center or Developer settings

You're likely missing the Account Settings permission — ask your admin to enable it

Connection fails in LeadTruffle

Re-copy the API key, check its permissions and use an API secret only for v1. A successful connection check does not confirm permission to create jobs

Credentials work then stop

If the key was regenerated in Workiz, enter the replacement in LeadTruffle and review the detected version and v2 custom-field defaults




Need help? Contact us at support@leadtruffle.com or message the team via the chat on this article or in-app.

Updated on: 27/10/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!