Connect Cityworks AMS / Citizen Engagement

A step-by-step guide with pictures, from the Speakvora agent's own Connect tab.

Short answer: This connects your own Trimble Cityworks account to your Speakvora agent. Then a customer can text where is order 1234 and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Trimble Cityworks. Only the status word and.

Every key, number and name in the pictures is a made-up example. Nothing here asks you to share a real key with anyone but the app on your own computer.

This connects your own Trimble Cityworks account to your Speakvora agent. Then a customer can text *where is order 1234* and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Trimble Cityworks. Only the status word and the order number are ever texted back, never names, prices, items or addresses.

TIP: You need about 15 minutes, a computer, and the sign-in for your Trimble Cityworks account (the owner or a manager). You can't break anything: if a step does not work, nothing has changed and you can just try again. The keys and screens below are made-up examples.

NOTE: This guide was written from Trimble Cityworks's public developer documentation (a few details could not be confirmed) and has not been tried yet on a live Trimble Cityworks account. If a screen looks different from what is described, press Connect, then Download report, and send it to support. We fix it for everyone.

Who this is for: government utilities. How Trimble Cityworks gives access: The vendor charges extra for API access or a higher plan. Check your plan before you start. What it costs you: Cityworks API use needs a Citizen Engagement API license, a Work Order Basic API license, or both. These may cost extra, so confirm with Cityworks or your reseller.

Part 1. Get your key from Trimble Cityworks

Do this on your computer, in a new browser tab, signed in to Trimble Cityworks.

  1. Ask your Cityworks administrator to confirm that your site has a Citizen Engagement API or Work Order Basic API license.
  2. Ask them for the address of your Cityworks Services (AMS) server that Speakvora can reach, and to allow Speakvora through the firewall if needed.
  3. Have them create a new dedicated user named for Speakvora, separate from any staff login.
  4. Give that user read-only rights to view service requests and work orders, with no create or update rights.
  5. If your site uses Trimble Identity, set the user to API Only and turn off MFA for it, as Cityworks 23.15.1 requires.
  6. In Speakvora, paste the Services address, user name and password, and ask Speakvora support to confirm the request lookup for your version.

WARNING: If Trimble Cityworks asks which permissions to give, tick only the read-only ones: Dedicated integration user with read-only access to service requests and work orders, On Trimble Identity (Cityworks 23.15.1+): account set to API Only, MFA off for that user. Never give write or admin access.

TIP: To copy the key, click inside the box that shows it, press Command + C on a Mac or Ctrl + C on Windows (or right-click and choose Copy). Nothing will look different. It is now in your clipboard, ready to paste. Keep it private: anyone who has it can read your orders.

Part 2. Open the Connect tab in your agent

  1. Open your agent's dashboard (the page you open from the Start Speakvora Agent file).
  2. Press Connect in the menu. On a phone the menu is the bar along the top; slide it sideways if you do not see Connect.
  3. Step 1: press Connect (1)

  4. Under Your apps type Trimble Cityworks in the box that says Find an app (1), or scroll down the list.
  5. Step 2: the Find an app box (1)

  6. Press Cityworks AMS / Citizen Engagement. A card slides up. (If you only see apps for your own kind of business, that is on purpose: your agent only shows the systems that make sense for it.)
  7. Step 3: an app's card. The Full Guide button (1) opens this page.

Part 3. Paste it in

3 boxes to fill in. Click inside a box, press Command + V on a Mac or Ctrl + V on Windows, then move to the next:

  1. Your Cityworks Services address. The address (without https://) of your Cityworks Services / AMS server. Your Cityworks administrator or IT team knows it.
  2. Integration user name. A dedicated non-interactive user created for Speakvora. With Windows Authentication use domain/username.
  3. Integration user password (secret: it stays on this computer and is never shown again, only the last few characters). The password of that dedicated integration user. Never use a personal login.
  4. Part 3: each numbered box is one thing to paste. These are made-up examples.

TIP: Pasted by mistake into the wrong box? Click the box, press Command + A (Ctrl + A on Windows) to select all, then paste again.

Part 4. Test it

  1. Press the orange Save and test button.
  2. Trimble Cityworks has no safe read-only check we can run, so nothing is called. The connection is used for real the first time a customer asks about an order, and any problem shows in Activity.
  3. Part 4: the green message under the buttons means it worked (1)

YOU SHOULD SEE: green words starting with Connected. (here: *Saved* and the sentence about the first customer)

WARNING: Red words mean it did not work yet. Read them, then see If something is wrong below. Nothing bad happened.

What happens next

  • A customer texts something like where is order 1234. The agent answers *Your order 1234 is preparing.* (the status word from Trimble Cityworks), or *I could not find that order. A team member will check and reply.*
  • Each person can ask five times an hour. If Trimble Cityworks is down, the conversation carries on and the problem is written to Activity.
  • Mode: the agent asks Trimble Cityworks when a customer asks.

If something is wrong

  • It says the key was refused (401 or 403): copy the key again from Trimble Cityworks. Make sure there is no space before or after it, and that it is a live key for the right shop or location.
  • It cannot find an order (404): the number is not in Trimble Cityworks, or Trimble Cityworks uses a longer number than the one on the receipt.
  • It says too many requests (429): wait a minute and press Save and test again.
  • Trimble Cityworks says you need a plan or approval: Cityworks' REST API reference is available to customers only, so the exact token request, order lookup path and status field name could not be confirmed from public pages. No test or order call is set. Public pages confirm only that an API license is needed and that integrations use a non-interactive, API-only integration user without MFA. Because this controls public infrastructure, use a read-only user.
  • Still stuck? Press Connect, then Download report, and email it to support. It never contains keys or customer messages.

If your plan has no API

  • Ask your Cityworks administrator or Trimble Cityworks reseller to confirm API licensing and give Speakvora a read-only integration user.
  • Without API access, tell callers to contact the public works or 311 line for request status.

Trimble Cityworks's own instructions: https://www.civicplus.help/seeclickfix/docs/seeclickfix-connect-for-cityworks

All help guides · Every agent feature · AI receptionist by industry

Questions

What if this happens: It says the key was refused (401 or 403)?

copy the key again from Trimble Cityworks. Make sure there is no space before or after it, and that it is a live key for the right shop or location.

What if this happens: It cannot find an order (404)?

the number is not in Trimble Cityworks, or Trimble Cityworks uses a longer number than the one on the receipt.

What if this happens: It says too many requests (429)?

wait a minute and press Save and test again.

What if this happens: Trimble Cityworks says you need a plan or approval?

Cityworks' REST API reference is available to customers only, so the exact token request, order lookup path and status field name could not be confirmed from public pages. No test or order call is set. Public pages confirm only that an API license is needed and that integrations use a non-interactive, API-only integration user without MFA. Because this controls public infrastructure, use a read-only user.

What if this happens: Still stuck??

Press Connect, then Download report, and email it to support. It never contains keys or customer messages.