This instruction describes the configurations to be implemented in TOPdesk to set up the BlueDolphin TOPdesk Connector for a single TOPdesk template to the BlueDolphin Object Definition Type connection.
Repeat this instruction for every BlueDolphin Object Definition Type you would like to be sourced from TOPdesk.
NOTE: Integration does not support relationships in BlueDolphin.
Pre-requisite:
Integration URL - connector URL to be provided by ValueBlue (Webhook URL)
TOPdesk - TOPdesk Template to BlueDolphin Object Type connector
Variable Settings
TOPdesk API Key - TOPdesk credentials with appropriate access via the TOPdesk API
TOPdesk API User - TOPdesk credentials with appropriate access via the TOPdesk API
Minimum appropriate access is an operator account with read and update rights on the asset template you want to synchronize. If a person, person group, operator, operator group, or supplier needs to be resolved, read rights on the supporting files are required as well.
NOTE: You can block the operator from logging into the TOPDesk GUI.
Configuration to be added to the TOPdesk
Once you install the Template name - BIF: TOPdesk Entity -> BlueDolphin Object (CREATE, UPDATE) template, you are navigated to the configuration page.
Take the value of the Webhook URL, object definition ID, and the workspace ID to create a webhook using this information for ObjectCreated and ObjectUpdated. Refer to the Subscriptions section for more information
In the General Configuration section, fill in all the required fields by referring to the table below.
Click Verify and Connect to confirm that the connector details are correct.
If the connection is successful, it says connected in the bottom right corner, and the Integration Mapping field appears.
In the Integration Mapping, map TOPdesk fields to the BlueDolphin object definitions you wish to connect.
This is the one-on-one field mapping table from the TOPdesk Template fields to the BlueDolphin Object Type properties or questionnaire fields.
Click Activate in the bottom right corner.
General Configuration Fields
Fill in all the details as described in the table,
Section | Field | Description |
Flow Name |
| Template name |
Webhook URL |
| TOPdesk webhook endpoint |
General Configuration | Instance URL | Address URL from the TOPdesk API |
| User Name | TOPdesk API account name |
| API Key | TOPdesk API Key |
| Asset type | Template from TOPdesk you want to connect to BlueDolphin |
| BlueDolphin ID Field (Mandatory) | BlueDolphin ID fields created in TOPdesk. For example, bluedolphin-id. |
|
(Mandatory) | In Topdesk, 'name' refers to the Asset ID and it matches the title in BlueDolphin. This field must be filled with 'name' for the TOPdesk integration. |
| API URL | BlueDolphin API URL For US tenants: |
| Tenant Name | Your tenant name can be found in the BlueDolphin URL behind "app/" |
| API Key | |
| Object Definition ID | BlueDolphin Object Definition ID you want to connect. Admin-> Configuration-> Object Definition: Select the object definition you want to use and copy and paste the end part of the URL. |
| Workspace ID | BlueDolphin Workspace ID you want to connect. Admin-> Configuration-> Business Units Select the workspace you want to use and copy and paste the end part of the URL. NOTE: Tenants with no workspace should use the “get workspace” call from the public API to retrieve it. |
TOPdesk package: The configuration required for TOPdesk is available in the attached .zip file.
It is now possible to have bi-directional data flow from BlueDolphin to TOPDesk. Refer to the BlueDolphin to TopDesk Integration article.