Workiz connector
Your Silux Chat bot verifies customers by their name and the email on their own bookings in Workiz, then answers questions about their appointments and bookings from your live data.
Good to know: Workiz authenticates with the token in the URL path. job/all covers the last 14 days by default.
What your bot can do with Workiz
Appointments and bookings
Reads upcoming and recent appointments or reservations from Workiz — date and time, service and status.
Customers ask: “When is my next appointment?” · “Is my booking confirmed?”
Set it up
Most businesses finish in under ten minutes. You need to be able to sign in to Workiz as an administrator to create the key.
Step 1 — in Workiz
- 1Workiz
- 2Settings
- 3Developer API (add-on)
- 4copy the API token. Workiz has no customer search, so the bot matches recent jobs on the customer's email.
Step 2 — in Silux Chat
- 1Open Dashboard → Integrations → Connectors and search for “Workiz”.
- 2Fill in:
Field Example Stored API token (api_…) •••••••• Encrypted - 3Press Connect & test. The platform makes a real, read-only call to Workiz with a made-up customer and shows a tick or a cross for each capability, with Workiz’s exact error if something is refused.
- 4If this is your first way of verifying customers it is switched on automatically; otherwise press Use to verify customers. The platform then runs its chained test (verify → code → account → orders → invoices) with the built-in test customer — no real person is contacted.
The private, unguessable webhook address you paste is the credential, so keep it to yourself. Anyone with the address can call your workflow.
How customer verification works
- STEP 1
Customer asks
They ask about their own account. The bot asks for their full name and the email address they used with you.
- STEP 2
Matched in Workiz
Workiz has no customer search, so the customer’s own bookings are looked up by that email. A record must name the exact email and a matching name: the surname exactly, and the first name or its first letter.
- STEP 3
Code emailed
A 6-digit code goes to that email address — the one on the record. It is never sent to a mobile number typed in the chat.
- STEP 4
Verified
The customer types the code. It is valid for 10 minutes and five wrong attempts cancel it. The verified session lasts 30 minutes, and only bookings naming that email are shown.
If the details don’t match, the customer is told only that they couldn’t be matched — never which detail was wrong. If Workiz can’t be reached, the bot says it can’t check accounts right now rather than “no account found”. The bot is blocked in code from reading orders, invoices or bookings until verification succeeds. Full details: Customer identity verification & OTP.
What the bot can and cannot see
Can see (after verification)
- Record ID
- Start time
- Service
- Status
- Email address
- Total
- Amount due
Only these standard fields are mapped from Workiz’s responses. Everything else in the response is discarded before the bot sees it.
Never sees
- passwords, security answers or login details
- records belonging to anyone other than the verified customer
- anything outside the fields listed alongside
Security
Keys encrypted at rest
Credentials are stored encrypted, shown only masked after saving, and destroyed — not just hidden — when you disconnect.
Read-only look-ups
Every capability is a look-up. The connector cannot create, change or delete anything in Workiz.
HTTPS only
Calls go to the vendor’s HTTPS address, redirects are not followed, and private network addresses are refused.
Injection-safe
Values a customer types are cleaned before they are placed in Workiz’s search, and URL-encoded in addresses.
Other customers filtered out
A row that names a different customer’s email is dropped, whatever the vendor’s search returned.
Checked daily
Connections are re-tested every day, and the owner is emailed if a working connection starts failing.
More: Security & data protection.
Technical details
For developers and IT teams: the Workiz endpoints this connector reads. Values in braces come from the settings you enter.
| Capability | Request | Standard fields returned |
|---|---|---|
| Appointments and bookings | GET/job/all/ | id, start, service, status, email, total, amount_due |
Test level: Documented-API tested. Each capability is run automatically against Workiz’s documented example responses and must produce the standard fields; your own connection is then tested with a real call when you connect. The bot receives these through the standard Account Connect endpoints, exactly as if you had built them yourself.
Troubleshooting
| What you see | Likely cause and fix |
|---|---|
| “the vendor refused the credentials (401)” or (403) | The key was revoked, has expired or was copied incompletely, or it lacks a read permission this connector needs. Create a fresh read-only key in Workiz and reconnect. |
| Customers are “not matched” although they exist | Customers are matched on their own bookings by the email they give. Check a recent record names that email and the customer’s name (surname exactly). |
| A capability shows a cross but others work | That permission wasn’t granted in Workiz, or your Workiz plan doesn’t include that part of the API. Grant it and press Test. |
| “the vendor kept rate-limiting the request” | Workiz returned “too many requests” three times in a row. The platform already waits and retries automatically (up to 10 seconds, as Workiz asks); if it persists, ask Workiz about your API quota. |
| Results are empty for a verified customer | The records exist under a different email or customer record in Workiz, or none are recent. Check the customer’s record in Workiz directly. |
Full error reference: Troubleshooting & error reference.
Frequently asked questions
Is the Workiz connection read-only?
Yes. Every request Silux Chat makes to Workiz is a look-up; none creates, changes or deletes anything in Workiz. Give the key or sign-in read-only permissions wherever Workiz offers them.
Do I need a developer to connect Workiz?
No. You paste the details listed in the set-up steps in Dashboard → Integrations → Connectors and press “Connect & test”. The platform makes a real call to Workiz straight away and shows exactly which features work.
How does the bot know it is really my customer?
Workiz has no customer search, so the bot looks up the customer’s own bookings by the email they give. A record must name that exact email and a matching name (surname, plus first name or initial) — then a one-time code is emailed to that address, never to a number typed in the chat. The code lasts 10 minutes, five wrong attempts cancel it, and a verified session lasts 30 minutes.
What happens if my Workiz key is revoked or expires?
The bot tells customers it can’t check their account right now — it never pretends there are “no orders”. Connections are re-tested daily and the account owner is emailed when a working connection starts failing. Reconnect it in Dashboard → Integrations → Connectors.
How has the Workiz connector been tested?
It is Documented-API tested: every capability is run automatically against Workiz’s documented example responses and must produce the standard fields. When you connect, it is tested again with a real call to your own Workiz account before your bot uses it.
Other field service connectors
Housecall Pro
Appointments and bookings · Recognise and verify customers · Invoices
Jobber
Appointments and bookings · Recognise and verify customers · Invoices
ServiceM8
Appointments and bookings · Recognise and verify customers · Invoices
ServiceTitan
Recognise and verify customers · Invoices · Support tickets and cases
simPRO
Account balance · Recognise and verify customers · Invoices · Support tickets and cases
Need help with your integration?
Our integration team can review your endpoints, help you choose the right connector and check a test run with you. Tell us which system you use and what you would like the bot to answer.