Skip to content

Scan Notifications

Notifications are triggered when a new scan becomes available for download, when existing scan files are updated or when a scan is sent to the iTero modeling services. Notifications are sent in the following scenarios:

  • After the initial scan is completed
  • After the scan is sent to modeling
  • After the modeling stage is completed
  • After a re-scan is completed, if the case was returned to the doctor

What does the notification include?

The notification includes the RXID of the scan, the account number related to this scan, as well as the specific Event Type of the scan.

  • An EventType value of ScanReadyForDownload signals to the caller that the scan files are available for download. Example: 
    {"Id":"RXID","CompanyId":"AccountID","EventType":"ScanReadyForDownload"}
  • An EventType value of ScanSentToModelingImmediately signals to the caller that the scan has been sent to the iTero modeling services. Example: 
    {"Id":"RXID","CompanyId":"AccountID","EventType":"ScanSentToModelingImmediately"}

How to set the notification address?

Two options are available for setting the address for notifications:

  1. Register an integration-wide notification URL with the iTero team. This URL will apply to all accounts that are paired with the 3rd party application.
  2. Set a notification URL per account in the Pair endpoint. For more details, check: Company Pairing

Considerations:

  • If no URL is provided, a notification will not be sent to the account.

  • To change the notification URL of a specific account, the account must unpair and then pair with the new URL.

  • If both the integration-wide URL and the Pair URL are provided, the notification will be sent to the third party's integration-wide URL and not to the one provided in the pairing call.

When to expect a notification?

  • Notifications for orders sent to modeling are available only to labs that route all orders to modeling and have this configured in myiTero.com by selecting “All Doctors” under Workflow Defaults. In addition, this feature must be explicitly enabled by the iTero team upon request.

  • A scan can trigger more than one notification depending on the specific scan's flow. If the scan continues with more flows, it will always maintain it's RXID.

Note

The notification follows a best‑effort delivery model. No retry mechanism is implemented.

Number Event Scan Status Notifications Event Type
1 3D files generated Completed Yes ScanReadyForDownload
2 Sent to modeling iTero Modeling Yes ScanSentToModelingImmediately
3 After modeling Lab Review Yes ScanReadyForDownload
4 Scan is sent back to the doctor via API or myitero portal Scanning / /
The doctor rescans and send back to lab Completed Yes ScanReadyForDownload