Help Docs

Glossary

Technical terms in setup, integrations, scheduling, phone routing, and patient texting approval. Every tooltip in the portal links back here for the longer explanation.

Integrations

6 terms

PMS

Software that runs scheduling, charts, and billing for a practice.

Copyable link

Why this matters

It lets Velyn sync patients, appointments, and office rules.

PMS stands for practice management system. It is the main system many dental offices use to manage schedules, patient records, insurance, treatment plans, and billing. When Velyn connects to a PMS, the portal can stay closer to the same patient and calendar data your staff already relies on.

Examples

  • Dentrix
  • Open Dental
  • Eaglesoft
  • Dentrix Ascend

API URL

The web address where a vendor API accepts requests.

Copyable link

Why this matters

We need it to send data to the right vendor system.

An API URL is the base address for a service your integration calls. Different vendors use different API URLs, and some practices receive environment-specific URLs from their vendor. Using the wrong API URL can make testing or sync fail even if the API key is correct.

Examples

  • https://api.opendental.com
  • https://nexhealth.info

Subdomain

The unique first part of a web address.

Copyable link

Why this matters

Some vendors use it to find your account.

A subdomain is the section before the main domain name, such as your-office in your-office.example.com. Some integrations ask for it because they partition customer accounts by subdomain rather than by email or office name.

Examples

  • your-office
  • brightsmile
  • downtown-dental

Location ID

A numeric ID for one office inside a vendor system.

Copyable link

Why this matters

It tells sync which location to read and update.

A location ID is a vendor-specific identifier for a practice or office location. If a vendor account covers multiple sites, this ID helps Velyn point at the correct one when reading appointments, providers, or patient records.

Examples

  • 12345
  • 987654

Endpoint

A specific URL for one action in an API.

Copyable link

Why this matters

Each setup step may need a different API path.

An endpoint is the exact URL a client calls for a single action, such as listing appointments or testing a connection. A base API URL usually contains many endpoints underneath it.

Examples

  • /api/api-keys
  • /api/health
  • /patients/search

Sync

An automatic update between two systems.

Copyable link

Why this matters

It keeps calendars and patient data current.

Sync means data is copied or refreshed between systems on a schedule or after certain events. A healthy sync helps staff avoid double entry and keeps the portal closer to the source of truth in the PMS.

Examples

  • Patient import
  • Appointment refresh
  • Provider update

Security

6 terms

API key

A secret code that proves a request is allowed.

Copyable link

Why this matters

It lets your server connect without sharing your password.

An API key is a secret credential used by software to authenticate with another service. It should be stored in secure server-side configuration, not inside browser code or public repos. If a key is exposed, you should revoke it and create a new one.

Examples

  • Portal API keys
  • Vendor-issued integration keys

OAuth

A secure sign-in flow that grants limited app access.

Copyable link

Why this matters

It connects calendars or tools without sharing your password.

OAuth is a standard way to connect one product to another without handing over your login password. You sign in with the provider, approve access, and the provider gives Velyn a limited token that can later be refreshed or revoked.

Examples

  • Google Calendar connection
  • Microsoft calendar connection

Callback URL

The address a service returns to after sign-in.

Copyable link

Why this matters

OAuth cannot finish unless the callback matches exactly.

A callback URL is the page or endpoint a provider sends users back to after they approve a sign-in or integration request. OAuth providers often require this URL to be registered exactly in advance. Even a small mismatch can block the connection flow.

Examples

  • Google OAuth redirect URL
  • Microsoft OAuth redirect URL

x-api-key header

The request field where an API key is sent.

Copyable link

Why this matters

Secure API calls are rejected if this header is missing.

HTTP requests can include extra metadata in headers. Some services expect an API key inside a header named x-api-key. If the key is sent in the wrong place, the request may look unauthenticated even though the key itself is valid.

Examples

  • x-api-key: your-secret-key

Bearer token

A short-lived access token sent with a request.

Copyable link

Why this matters

Some integrations use it instead of a long-lived API key.

A bearer token is a credential that grants access to a service for a limited time. It is commonly sent in an Authorization header. Because these tokens often expire, integrations need a refresh or re-authentication path.

Examples

  • Authorization: Bearer eyJ...
  • OAuth access tokens

Credentials

The secret details that prove your system can connect.

Copyable link

Why this matters

Bad credentials stop setup, sync, and testing.

Credentials are the secret pieces of information an app needs to prove it has permission to connect. Depending on the vendor, that may include an API key, client secret, token, username, password, or a combination of several values.

Examples

  • API key
  • OAuth client secret
  • Vendor account token

Scheduling

3 terms

Timezone

The local time setting for your practice.

Copyable link

Why this matters

Hours, reminders, and reports use this clock.

Your timezone tells the portal which local clock to use for the practice. Appointment windows, office hours, after-hours behavior, dashboards, and daily summaries all depend on this value. A wrong timezone can make hours look correct in one place but incorrect somewhere else.

Examples

  • America/New_York
  • America/Chicago
  • America/Los_Angeles

Timezone offset

The hour difference between local time and UTC.

Copyable link

Why this matters

It keeps cross-system schedules from drifting.

A timezone offset is the numeric difference between a local timezone and UTC. It is useful when comparing systems that store timestamps differently. Offsets can change during daylight saving time, which is why named IANA timezones are usually safer than hard-coded offsets.

Examples

  • UTC-05:00
  • UTC+01:00

IANA timezone

A standard timezone name like America/Chicago.

Copyable link

Why this matters

It handles daylight saving changes more reliably.

IANA timezone names come from the shared timezone database used by modern systems. They are more reliable than simple labels such as Central Time because software can use them to apply the right daylight saving rules over time.

Examples

  • America/New_York
  • Europe/London
  • America/Phoenix

Localization

3 terms

Country code

The +1 or +52 part at the start of a phone number.

Copyable link

Why this matters

Calls and texts can fail if it is missing.

A phone country code is the international prefix at the start of a number. Including it makes the number unambiguous across carriers and countries, which is especially important when software sends messages or initiates calls automatically.

Examples

  • +1 for the United States and Canada
  • +52 for Mexico

ISO code

A standard code like US, MX, en, or es.

Copyable link

Why this matters

It keeps country and language data consistent.

ISO codes are short standard codes published for countries, languages, and other shared data formats. They help different systems agree on the same meaning without relying on spelling or translations.

Examples

  • US
  • CA
  • en
  • es

Language code

A standard language code like en or es.

Copyable link

Why this matters

It helps messages and routing use the right language.

A language code is a compact way to represent a language in software. The portal can accept plain language names or codes, but using recognized codes can make integrations and downstream tooling more predictable.

Examples

  • en for English
  • es for Spanish
  • fr for French

Phone

7 terms

Webhook URL

A URL another service calls when an event happens.

Copyable link

Why this matters

Twilio sends live call events here so Velyn can respond.

A webhook URL is an incoming endpoint. Instead of Velyn polling for updates, a service such as Twilio sends an HTTP request to this URL when something important happens, such as an inbound call or a routing event. If the URL is missing or incorrect, live call handling can break.

Examples

  • Twilio voice webhook
  • Status callback endpoint

IVR

Interactive voice response for handling phone calls.

Copyable link

Why this matters

It powers menus, routing, and automated call flows.

IVR stands for interactive voice response. It is the phone system logic that answers calls, presents options, routes callers, and triggers automated actions. In Velyn, IVR settings shape how live calls move through your office workflow.

Examples

  • Press 1 for emergencies
  • Route to voicemail after hours

Routing mode

The call-handling path your phone setup uses.

Copyable link

Why this matters

It decides whether AI answers, forwards, or escalates.

Routing mode controls how inbound calls are processed. One mode may send calls into an AI workflow through a webhook, while another may forward calls directly to staff or an outside number. Changing this setting changes the behavior patients experience on live calls.

Examples

  • Twilio webhook mode
  • Forward-only mode

Transfer rule

A rule that sends a caller to a person or number.

Copyable link

Why this matters

It controls when AI hands the call to your staff.

A transfer rule defines the conditions for moving a call from Velyn to a human or another destination. Practices often use transfer rules for emergencies, scheduling edge cases, billing questions, or after-hours escalation.

Examples

  • Transfer all emergency calls
  • Forward after-hours callbacks

Voicemail

A recorded message left when no one answers.

Copyable link

Why this matters

It preserves caller intent when staff cannot pick up.

Voicemail captures a caller message for later review. In the portal, voicemails can appear with transcripts and related task follow-up so staff can respond without listening from scratch every time.

Examples

  • After-hours callback request
  • New patient message

Patient texting approval

Carrier approval that lets your practice number send patient texts.

Copyable link

Why this matters

Texts stay blocked until approval is submitted and approved.

Patient texting approval is Velyn’s plain-language name for A2P 10DLC carrier review. Open Practice Settings > Integrations > Patient texting approval to submit required business details, retry a failed submission, or resubmit carrier-requested updates.

Examples

  • Submit approval
  • Retry approval
  • Review updates

Texting approval status

The current carrier-review state for patient texting.

Copyable link

Why this matters

It tells staff whether to submit, wait, retry, or update details.

The portal can show Never submitted, Needs retry, Needs updates, Pending review, or Approved. Needs retry means submission failed before review could continue. Needs updates means carriers reviewed the submission and require corrected details before patient texts can send.

Examples

  • Never submitted
  • Needs retry
  • Needs updates
  • Pending review
  • Approved

Insurance

2 terms

In-network

A plan your office has contracted rates with.

Copyable link

Why this matters

It changes how insurance answers should be phrased.

In-network means the practice participates with an insurance plan or carrier under agreed pricing. The portal can use this status to guide safer wording, but practices still need staff verification for coverage, benefits, and patient-specific details.

Examples

  • Delta Dental PPO
  • Aetna PPO

Out-of-network

A plan your office does not bill at contracted rates.

Copyable link

Why this matters

It changes what callers should expect about benefits.

Out-of-network means the practice is not contracted with a plan at that plan’s negotiated rates. Patients may still have benefits, but exact coverage and out-of-pocket amounts must be verified by the practice or insurer.

Examples

  • Patient may have reimbursement after the visit