Connect Open Dental

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

Short answer: This connects your own Open Dental Software 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 Open Dental Software. Only the status word.

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 Open Dental Software 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 Open Dental Software. 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 Open Dental Software 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 Open Dental Software's public developer documentation (a few details could not be confirmed) and has not been tried yet on a live Open Dental Software 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: healthcare. How Open Dental Software gives access: The vendor charges extra for API access or a higher plan. Check your plan before you start. What it costs you: Open Dental's API page lists a free read-only tier limited to one request per 5 seconds and paid per-location tiers with higher limits; the developer pays. Confirm current pricing with Open Dental.

Part 1. Get your key from Open Dental Software

Do this on your computer, in a new browser tab, signed in to Open Dental Software.

  1. Sign in to Open Dental as the practice administrator.
  2. Ask Speakvora support for the developer key, or ask Open Dental support to approve Speakvora as an API developer with read-only access (ApiReadAll) to Appointments.
  3. The developer generates a Customer Key for your office in the Open Dental Developer Portal and tells you.
  4. In Open Dental open Setup, then Advanced Setup, then API.
  5. Tick Enabled in API Setup, press Add Key in the lower left, paste the Customer Key and save. The office also needs the eConnector running.
  6. Confirm the key is enabled and shows read-only permissions; changes can take up to 15 minutes.
  7. Paste the combined authorization value here, written as ODFHIR then the developer key, a slash, and your customer key.

WARNING: If Open Dental Software asks which permissions to give, tick only the read-only ones: ApiReadAll (read-only, includes Appointments). 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 Open Dental Software 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 Open Dental. 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

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

  1. Open Dental API authorization value (secret: it stays on this computer and is never shown again, only the last few characters). The text ODFHIR, a space, the developer key, a slash, then your office's customer key. Open Dental sends this as the Authorization header.
  2. 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. Open Dental Software 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 Open Dental Software), or *I could not find that order. A team member will check and reply.*
  • Each person can ask five times an hour. If Open Dental Software is down, the conversation carries on and the problem is written to Activity.
  • Mode: the agent asks Open Dental Software when a customer asks.

If something is wrong

  • It says the key was refused (401 or 403): copy the key again from Open Dental Software. 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 Open Dental Software, or Open Dental Software 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.
  • Open Dental Software says you need a plan or approval: Open Dental keys are issued through its Developer Portal to an approved developer, which then assigns a Customer Key to each office. A practice cannot create its own key. The Authorization format (ODFHIR developer/customer) came from a search summary of the docs, not from a page read directly, and no cheap test call is documented, so no test is configured. Appointments are looked up by AptNum (GET /appointments/{AptNum}), not by a patient-friendly number; the response holds a patient number, not a name. Requests are throttled (429 with Retry-After) and the API handles protected health information, so a Business Associate Agreement is needed.
  • 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 Open Dental support whether your office can use an existing approved integration partner instead.

Open Dental Software's own instructions: https://www.opendental.com/site/apispecification.html

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 Open Dental Software. 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 Open Dental Software, or Open Dental Software 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: Open Dental Software says you need a plan or approval?

Open Dental keys are issued through its Developer Portal to an approved developer, which then assigns a Customer Key to each office. A practice cannot create its own key. The Authorization format (ODFHIR developer/customer) came from a search summary of the docs, not from a page read directly, and no cheap test call is documented, so no test is configured. Appointments are looked up by AptNum (GET /appointments/{AptNum}), not by a patient-friendly number; the response holds a patient number, not a name. Requests are throttled (429 with Retry-After) and the API handles protected health information, so a Business Associate Agreement is needed.

What if this happens: Still stuck??

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