ScanCircle - Integration

Autotask

Tue, 30 Sep 2025 21:12:03 +0200

NOTE: No changes have been made yet in Autotask to support this integration and the integration has not been certified by Datto yet.
NOTE: the information below describes the functionality of release 2.12 (currently release 2.11 is operational)

By specifying the Autotask ticket number as a reference code for a scan, by default:

The device specs are stored as a Configuration Item (asset), so that you don't need to enter this data manually;
The Configuration Item is linked to the ticket;
The scans are logged as internal comments (so you can track the status of the device from check-in to check-out);
Any changes to the device specs are also logged in the internal comment (so you can see what has been changed between scans).

You can also automatically create a new ticket when performing a scan, so you don 't need to do this upfront.

Please watch the partner video first. @TODO

Setup instructions:

In your Autotask account, create a new API user: Admin > COMMONLY USED: Resources (Users) > Click the 'V' next to '+ New' > Select 'New API user':
1. First Name: 'API'
2. Last Name: 'ScanCircle'
3. Email address: 'api@scancircle.com'
4. Security Level: any security level (e.g. 'API User (system) Can't Read Costs')
5. Primary Internal Location: any location (e.g. 'Headquarters')
6. Click the Generate Key button (optionally change it to e.g. scancircle@...) and copy/remember this value
7. Click the Generate Secret button and copy the generated value
8. Under API Tracking Identifier, select 'Integration Vendor' and 'ScanCircle'
  - If 'ScanCircle' is not yet available as 'Integration Vendor', select 'Custom (Internal Integration)', Internal Integration Name: 'ScanCircle' and copy the generated 'Tracking Identifier' (don't overwrite the Secret value in the clipboard)
9. Click Save & Close
In your ScanCircle partner environment, add the Autotask integration: Login > Integrations tab > Integration = 'Autotask':
1. User Name: the generated Username (Key) value
2. Client Secret: the generated Password (Secret) value
3. If you selected 'Custom (Internal Integration)', then add tracking= and the generated 'Tracking Identifier' to the More options setting
4. Click Connect to connect to Autotask and retrieve the select list options and the default values
5. Next, optionally change other fields and the Advanced settings, but the defaults usually suffice (for all fields, a description is shown at the righthand side)
6. Click Check to validate the configuration and generate/update the Shortcuts value (under 'Advanced settings'). If configuration entities are missing in Autotask, you will be prompted to have them created automatically. This will create a 'Configuration Item Category' with the name 'ScanCircle Device' (or the first name specified in the asset parameter), with the user defined fields Make & Model, OS, Motherboard, BIOS, Processor, Memory, Disk Info, Display Adapter(s), OS Installed, Product Keys, IP Address (fields that do not yet exist will be created) as well as the 'Configuration Item Type' and 'Product' with the same name
7. Finally, click OK and don't forget to click Save
Under the Scan widget tab:
1. Specify the name of a URL parameter (e.g. 'ticketno') if you want to set the ticket number in a link, e.g. https://domain.com/scan?ticketno=xyz
2. Specify an input field label (e.g. 'Ticket number') if you want the end-user to see/change/enter the ticket number
3. Optionally specify a category (e.g. 'ticket') if you want this widget to only handle specific Autotask reference codes (those containing the text 'ticket:'). Make sure you specify the same category in the 'Integrations' setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. email address or phone number) which do not match any ticket number (as failed matches will be forwarded to the next integrations option)
4. Copy the generated HTML code or shortcode to your website

Day-to-day use:

Create a new ticket in Autotask: fill in the required fields and click Save (NOT Save & Close). This will show the ticket number generated at the top (e.g. T20250930.0001);
Then perform a ScanCircle scan on the device and enter the generated ticket number as reference code. This will store the device specs in a Configuration Item linked to the ticket and log the scan in the ticket;
Now print/email a claim ticket for the customer if required and start fixing the device;
Before you return the device, always perform another scan with the ticket number as reference code (logs the end state) and optionally print/email the ScanCircle Scan report (containing the before-and-after state) for the customer;
You may allow the customer to periodically scan its device using the ticket number (tip: send them a link containing the ticket number after e.g. 3 months);
If you want to update the device specs manually, use the default 'Changes' setting, then update the specs based on the changes in the internal comments.

Note: This plugin is as standard provided and maintained by ScanCircle. You do no need to install anything yourself.

If you want to use this plugin, please subscribe to this discussion using the option in the lower left corner of this page so that you will be notified of any updates automatically.

HaloPSA

Fri, 15 Aug 2025 21:37:57 +0200

NOTE: No changes have been made yet in HaloPSA to support this integration, but they are working on a market place which may make the configuration even easier.

ScanCircle can forward the device specifications and scans to HaloPSA, by default:

The device specs are stored as an asset (so that you don't need to enter this data manually);
The asset is linked to the ticket number specified in the reference code when running a scan;
The scans are logged as internal comments for that ticket (so you can track the status of the device from check-in to check-out);
Any changes to the device specs are also logged in that internal comment (so you can see what has been changed between scans).

Please watch the partner video first. @TODO

Requirements:

In your HaloPSA account:
1. Create a new API application: Configuration > Integrations > HaloPSA API > View Applications > + New
2. Enter the following: Application Name = 'ScanCircle', Authentication Method = 'Client ID and Secret (Services)', Agent to log in as = select the agent account that will be used to perform the API operations
3. Copy the generated Client Secret (it will only be shown once): optionally click Generate to generate a new value and click Copy
4. On the Permissions tab, check the following options (admin is only required during initial): admin, read:tickets, edit:tickets, read:assets, edit:assets
5. Switch back to the Details tab, save the changes and leave this page open: Details tab > Save
In your ScanCircle partner environment:
1. Add the HaloPSA integration: Login > Integrations tab > Integration = 'HaloPSA'
2. First fill in the copied Client Secret
3. Then copy the Client ID from the open HaloPSA API application Details tab
4. Fill in the Subdomain with the HaloPSA subdomain
5. Optionally change other fields and the advanced settings, but the defaults usually suffice (for all fields, a description is shown at the righthand side)
6. Click Check to validate the configuration. If the asset type does not yet exist, you will be prompted to have it created automatically. This requires the 'admin' permission and will create the asset type ('ScanCircle Device' or the name specified under Asset type(s)) for asset group 'Computing' withthe fields: Name (as key field 1), Serial Number (as key field 2), Model, OS Version, Main Board, BIOS, Processor, RAM Memory, Disc Size, Video Card, OS Date, Licence Number, IP Address (fields that do not yet exist will be created)
7. Finally, click OK and don't forget to click Save
Go back to your HaloPSA account and remove the 'admin' permission: Edit > Permission tab > uncheck 'admin' > Save
Go back to your ScanCircle partner environment to the Scan widget tab:
1. Specify a 'Label input field' (e.g. 'Email address / ticket number') if you want visitors to enter their email address or a ticket number for a scan. This will be used as reference code to match a ticket in HaloPSA. If there is no match, then the scan notification will be forwarded to the next integration specified (or ultimately the specified email address)
2. Specify a 'URL parameter' (e.g. 'ticket') if you want to set the ticket number in a link for your clients, e.g. https://domain.com/scan?ticket=xyz
3. Copy the generated HTML code or CMS shortcode to your website
Day-to-day use:
1. Create a new ticket in HaloPSA: select/enter the end-user, fill in the required fields and click Submit. This will show the ticket number generated in the top left corner and on the tab (e.g. ID:0001234 and 1234);
2. Then perform a ScanCircle scan on the device and enter the generated ticket number as reference code (in this case 1234). This will store the device specs in an asset linked to the ticket and log the scan in the ticket;
3. Now print/email a claim ticket for the customer if required and start fixing the device;
4. Before you return the device, always perform another scan with the ticket number as reference code (logs the end state) and optionally print the ScanCircle Scan report (containing the before-and-after state) for the customer;
5. You may allow the customer to periodically scan its device using the ticket number (tip: send them a link containing the ticket number after e.g. 3 months);
6. If you want to update the device specs manually, use the default 'Changes' setting, then update the specs based on the changes in the internal comments.

My Gadget Repairs

Tue, 28 Nov 2023 18:22:46 +0100

Credits: My Gadget Repairs have been enormously helpful getting this interface to work optimally (even making changes to their API). Using their 3rd Party Integration, all configuration is done automatically for you.

By specifying the My Gadget Repairs ticket number as a reference code for a scan, by default:

The computer specs are stored as an asset (so that you don't need to enter this data manually);
The asset is linked to the ticket;
The model and serial number are also stored in the ticket;
The scans are logged as internal comments (so you can track the status of the computer from check-in to check-out);
Any changes to the computer specs are logged as internal comments (so you can see what has been changed between scans).

Please watch the partner video first.

Requirements:

In your My Gadget Repairs account, go to the "ScanCircle Computer Diagnosis" integration (under "3rd Party Integration"). If you have not yet generated an API Key, one will be created for you and sent to you by email. Make sure you click "Save Configuration" to:
1. Create the "ScanCircle device" asset type;
2. Create the following custom fields (in addition to the standard fields name, serial and model): OS, Mobo, BIOS, CPU, RAM, Disks, Video, Installed, Licenses (only for scans in partner mode) and IP. If you would like to disable any of these custom fields, go to Tickets/Customers > Asset Manager > Custom Fields & Form Fields Mapping and change the "Status" of the required field from "Active" to "Inactive";
3. Create a "Generic brand ("*") to which the ScanCircle models will be linked. ScanCircle models are in the format: " (
  )", e.g. "Dell Inc. XPS 17 9700 (Mobile)". This is a technical limitation that may cause some duplication e.g. if you already have models like "XPS 17 9700" linked to brand "Dell";
In your ScanCircle partner environment, select the Integrations tab. Add the destination "My Gadget Repairs" and fill in the required fields (only "API Key" is required). Optionally change the other fields and the advanced settings, but the defaults usually suffice. For all fields, a description is shown at the righthand side. Click "Check" to check the connection and then click "OK". Optionally add alternative destinations (e.g. for other categories) and make sure to finish with an "Email" address to which unhandled scan notifications and referral notifications will be sent. Finally click "Save";
Now generate a scan widget in your ScanCircle partner environment (on the "Scan widget" tab) and copy the generated HTML code or shortcode to your website:
1. Specify the name of a URL parameter (e.g. "ticketno") if you want to set the ticket number in a link, e.g. https://domain.com/scan?ticketno=xyz;
2. Specify an input field label (e.g. "Ticket number") if you want the end-user to see/change/enter the ticket number;
3. Optionally specify a category (e.g. "ticket") if you want this widget to only handle specific My Gadget Repairs reference codes (those containing the text "ticket:"). Make sure you specify the same category in the "Integrations" setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. email address or phone number) which do not match any ticket number (as failed matches will be forwarded to the next integration option as standard);
Day-to-day use:
1. Create a new ticket in My Gadget Repairs, fill in the required fields (Customer and Short info) and click '+ Add New Ticket'. This will show the ticket number generated in the top left corner under the tabs (e.g. RPR-1);
2. Then perform a ScanCircle scan on the computer and enter the generated ticket number as reference code. This will set the specs and log the initial state of the computer;
3. Now print a claim ticket for the customer and start fixing the computer;
4. Before you return the computer, always perform a last scan with the ticket number as reference code (logs the end state) and optionally print the ScanCircle Scan report (containing the before-and-after state) for the customer;
5. You may allow the customer to periodically scan its computer using the ticket number (tip: send them a link containing the ticket number after 3/6/12 months);
6. If you want to update the computer specs manually, use the default "Changes" setting, then update the specs based on the changes in the internal comments.

d7x

Wed, 01 Jan 2020 18:29:47 +0100

Partners using d7x (v19.12.10.0+) can use variables for client name and ticket number, %name% and %num% respectively, so you would use them like https://domain.com/scan?reference=%num%

Feed emails into PSA/RMM/ticketing systems

Tue, 13 Feb 2018 23:10:39 +0100

To feed scans into ticketing systems that support creating tickets based on an email, you can specify that email address in the "Integrations" setting.

To avoid creating unnecessary tickets you may want to create "workflow rules" to filter the required notifications:

Sender equals "noreply@scancircle.com";
Subject starts with "Reference scan", "Partner scan" or "Anonymous scan " (excludes "Internal referral" and "External referral" notifications);
Subject contains or ends with a specific reference between parenthesis: e.g. specify "ticket" as reference code during the scan then Subject will end with "(ticket)";
Body contains a specific target name: on the partner "Advertisements" tab, add one or more Targets with a specific "Name" and "Condition" (e.g. "CREATE_TICKET" for "Minimum scan score is NOT 6").

Thanks to partner TrotsIT for implementing and testing this with Autotask AEM PSA.

RepairShopr/SyncroMSP

Fri, 10 Mar 2017 16:58:27 +0100

IMPORTANT NOTE: No changes have been made yet in RepairShopr/SyncroMSP to support this interface and some steps need to be done manually at this moment. If sufficient interest is shown in the interface, they may automate some of these steps (e.g. 1, 2 and 5b2).

By specifying the RepairShopr or SyncroMSP ticket number as a reference code for a scan, by default:

The computer specs are stored as an asset (so that you don't need to enter this data manually);
The scans are logged as internal ticket comments (so you can track the status of the computer from check-in to check-out);
Any changes to the computer specs are logged as internal ticket comments (so you can see what has been changed between scans).

Please watch the partner video first (needs to be updated to reflect the new Integrations user interface and other changes in release 2.11).

Requirements:

In your RepairShopr/SyncroMSP account, create a new asset type ScanCircle Device (Admin > Asset Custom Fields > + New Asset Type) and add the (non-required text) fields listed below (Manage Fields). Use the exact field names (respect their case) en reorder them in any way you want. You may omit any field that you are not interested in, except for "Serial":
- Serial
- Make
- OS
- CPU
- RAM
- Video
- Disks
- Board
- BIOS
- Installed
- Licenses
- IP
Create an API key (Admin > API Tokens > New Token > Custom Permissions) named "ScanCircle" without expiration with the permissions listed below, click "Create API Token" and copy the API token created:
- Assets - List/Search
- Assets - Edit
- Assets - Create
- Tickets - List/Search
- Tickets - View Details
- Tickets - Edit
- Ticket Comments - New
In your ScanCircle partner environment, select the Integrations tab. Add the destination "RepairShopr" or "SyncroMSP" and fill in the required fields ("Subdomain" and "API Key"). Optionally change the other fields and the advanced settings (e.g. set unwanted fields to "ignore"), but the defaults usually suffice. For all fields, a description is shown at the righthand site. Click "Check" to check the connection and then click "OK". Optionally add alternative integrations (e.g. for other categories) and make sure to finish with an "Email" address to which unhandled scan notifications and referral notifications will be sent. Finally click "Save";
Generate the scan widget in your ScanCircle partner environment (on the Scan widget tab) and copy the generated HTML code or shortcode to your website:
1. Specify the name of a URL parameter (e.g. "ticketno") if you want to set the ticket number in a link, e.g. https://domain.com/scan?ticketno=12345;
2. Specify an input field label (e.g. "Ticket number") if you want the end-user to see/change/enter the ticket number;
3. Optionally specify a category (e.g. "ticket") if you want this widget to only handle RepairShopr/SyncroMSP reference codes (those containing the text "ticket:"). Make sure you specify the same category in the "Integrations" setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. email address or phone number) which do not match any ticket number (as failed matches will be forwarded to the next integration option as standard);
Day-to-day use:
1. Create a new ticket in RepairShopr/SyncroMSP by filling in the required fields and click "Create Ticket";
2. Then perform a ScanCircle scan on the computer and enter the new ticket number as reference code (this will set the specs and log the initial state of the computer):
  1. If nomatch=one (default) and the customer does not have any computer assets at all or if nomatch=any and there is no match on name andserial number, then a new computer asset will be created and linked to the customer;
  2. You can link that asset to the ticket by editing the ticket and under 'Relevant Assets', click 'Add existing', select/search the asset and click 'Add';
3. Now print a claim ticket for the customer and start fixing the computer;
4. Before you check out the computer, always perform a last scan with the ticket number as reference code (logs the end state) and optionally print the ScanCircle before-and-after report for the customer;
5. You may allow the customer to periodically scan its computer using the ticket number (tip: send them a link containing the ticket number);
6. If you want to update the computer specs manually, use the default changes setting (log), then update the specs based on the changes in the internal comments and optionally remove the internal comments;
7. Note: only the first digits of the reference code (excluding any category) are used to find a match, so you may add additional information (e.g. '123 client A' will match 123).

Notes:

This plugin is as standard provided and maintained by ScanCircle. You do no need to install anything yourself;
The standard RepairShopr/SyncroMSP 'Asset Serial Number' is not used because it must be unique and computer serial numbers unfortunately aren't;
The RepairShopr/SyncroMSP Computer Asset field 'Service Tag' is not used because the general term is 'Serial Number'.

If you want to use this plugin, please subscribe to this discussion using the option in the lower left corner of this page so that you will be notified of any updates automatically.

PC Repair Tracker

Thu, 19 Nov 2015 16:13:33 +0100

TO USE THE LATEST FUNCTIONALITY, DOWNLOAD THE ATTACHED scancircle2pcrt.php AND INSTALL IT IN YOUR PCRT repair DIRECTORY

By specifying the PC Repair Tracker (PCRT) asset/device id (pcid) as a reference code for a scan, by default:

The computer specs are stored with the asset/device (so that you don't need to enter this data manually);
The scans are logged as asset attachments (so you can track the status of the computer from check-in to check-out);
Any changes to the computer specs are logged as internal notes (so you can see what has been changed between scans).

Please watch this partner video first (needs to be updated to reflect the new Integrations user interface in release 2.8).

Requirements:

In your PC Repair Tracker environment:
1. Go to Settings > Integration Info >Go and copy the API key for the ScanCircle integration. If you don't have an API key yet or want to change it, select Settings > Create New Store Hash > Go;
2. This interface relies on the mainassetinfofields table in the PCRT database to contain the following matchwords (the fields marked with "*" are non-standard and can be manually added to the database table if required):
  - serial (serial number)
  - operatingsystem
  - cpu
  - ram
  - partition (disk drives)
  - videocard
  - bios
  - installedon
  - windowsproductkey (only for scans in partner mode)
  - computername*
  - motherboard*
  - ipaddress*
In your ScanCircle partner environment, select the Integrations tab. Add the destination "PC Repair Tracker" and fill in the required fields (only "URL" and "Store Hash" are required). Optionally change the other fields and the advanced settings, but the defaults usually suffice. For all fields, a description is shown at the righthand site. Click "Check" to check the connection and then click "OK". Optionally add alternative destinations (e.g. for other categories) and make sure to finish with an "Email" address to which unhandled scan notifications and referral notifications will be sent. Finally click "Save";
Generate the scan widget in your ScanCircle partner environment and copy the generated HTML code or shortcode to your website:
1. Specify the name of a URL parameter (e.g. "pcid") if you want to set the pcid in a link , e.g. https://domain.com/scan?pcid=1234;
2. Specify an input field label (e.g. "PC number or email address") if you want the end-user to see/change/enter the pcid;
3. Specify a category if you want this widget to only handle PCRT reference codes. Make sure you specify the same category in the "Integrations" setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. e-mail address or phone number) which do not match any PCRT pcid (as failed matches will be forwarded to the next integration option as standard);
Day-to-day use:
1. When you check in a new computer, you do not need to enter the computer specs and do not print the claim ticket yet;
2. Then perform a ScanCircle scan on the computer and enter the new pcid as reference code (this will set the specs and log the initial state of the computer);
3. Now print the claim ticket for the customer and fix the computer;
4. Before you check out the computer, always perform a last scan with the pcid as reference code (logs the end state) and optionally print the ScanCircle before-and-after report for the customer;
5. You may allow the customer to periodically scan its computer using the pcid (suggestion: give them a link containing the pcid).
Notes:
1. Only the first digits of the reference code (following any category+colon) are used to find a match, so you may add additional information (e.g. "1234 client A" will match 1234);
2. This add-on was as standard provided in PCRT v2.1-v9. Since there have not been any new releases, please install the attached scancircle2pcrt.php in your PCRT repair directory;
3. If you want to add any pre or post processing, you can create a file called scancircle2pcrt_pre.php and/or scancircle2pcrt_post.php with your own PHP code in your PCRT repair directory;
4. If you are still using PCRT v2.0 or v1.40, please replace the wo.php file in your PCRT repair directory with the relevant attached version to open the scan links in the main repair page;
5. The standard module SimpleXML must be installed (and not disabled) in your PHP environment.

If you want to use this add-on, please make sure you subscribe to this discussion using the option in the lower left corner of this page so that you will be notified of any updates automatically.

  wo_v2.0.php (Size: 97,07 KB / Downloads: 0)

  wo_v1.40.php (Size: 118,48 KB / Downloads: 0)

  scancircle2pcrt.php (Size: 14,23 KB / Downloads: 3)

Standard notification of scans/referrals

Sun, 01 Sep 2013 14:07:29 +0200

Notifications to partners (for scans or referrals) can be done by email or by post:

Email: The email is in HTML format with a so-called plain-text alternative. The sender of the email is noreply@scancircle.com (add this email address to a white list to avoid blocking by strict spam filters)
Post: An HTTP post of an XML structure called "info" with one root node and one level of sub nodes. Use this method to process notifications automatically.

In the definitions below, the variables are enclosed in curly brackets and explained in the variable list below. The XML sub nodes contain the variables indicated by the node name (e.g. {advice}).

Scan: when a user performs a scan in your partner environment

Email subject: "{source} scan results for {name}/{volumeid}/{serial}[ ({reference})]" ([] = optional)
Email body contains: {advice}, {make}, {mobo}, {bios}, {os}, {installed}, {cpu}, {memory}, {video}, {disk}, {lastboot}, {ip} ({iplocation}), {score}, {targets}, {keys}, {message}
Post XML root node: scan
Post XML sub nodes: advice, language, scanmode, reference, name, volumeid, serial, make, mobo, bios, os, installed, cpu, memory, video, disk, lastboot, redirect, ip, iplocation, score, targets, keys, oskey*
Post reply: the script should return (echo) "OK" to indicate that it is successful or a URL to redirect the user to a specific webpage. Other responses are regarded as error, then the message will still be sent to the next alternative. This continues until no more alternatives are available.

*) To support existing scancircle2pcrt v1.35 implementations, the license keys will also be included in an node for the moment

Referral: when a user of your own partner environment clicks on one of your advertisements or asks for support (internal referral) or a user of the general www environment clicks on your entry on the map (External referral)

Email subject: "Internal referral" or "External referral"
Email body contains: {advice}, {from}, {location}, {reference}, {redirect}, {ip}, {message}, {explanation}
Post XML root node: referral
Post XML sub nodes: type, advice, from, location, reference, redirect, ip
Post reply: there is no check on the response.

Variable list:

{advice}: result URL for the expert (the Advice tab)
{bios}: device's Basic IO System
{cpu}: processor specs
{disk}: local storage devices (drive names and size)
{from}: partner code where the scan is performed (your own partner code for an internal referral, www for the general environment)
{installed}: OS installation date
{ip}: external IP address
{iplocation}: city+state+country based on IP address
{language}: active language code (en/nl)
{lastboot}: last system boot date
{keys}: license keys in the format {name}:{value}, separated by semi-colons (only in partner mode)
{location}: a Google Maps link to the city (based on IP address) or the location specified by the user (only for external referrals)
{make}: device brand and model
{memory}: total memory installed and number and size of memory modules
{message}: an optional reply/error message from a post method (scan) or an explanation (referral)
{mobo}: mother board
{name}: device name
{os}: operating system
{redirect}: the URL the end-user is redirected to (Summary tab for results or custom URL for referrals)
{reference}: optional reference code
{scanmode}: d=direct, p=partner, a=automatic, m=manual, e=alternative in MSIE
{score}: total scan score (optionally with one decimal, '?' if OS unknown)
{serial}: device serial number as specified by the manufacturer
{source}: "Partner" (if partner mode), "Reference" (if reference code specified) or "Anonymous" (otherwise)
{targets}: names of the targets that meet your specified advertisement conditions (separated by commas)
{type}: type of referral "Internal" or "External"
{video}: video adapter card(s)
{volumeid}: volume serial number of primary hard drive