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 BlueDolphin (Webhook URL)
Action Sequence Script: Automation script in TOPdesk that will be provided by BlueDolphin
Variable Settings in the Action Sequence Script:
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.
BlueDolphin Configuration
Once you install the Template - BIF: TOPdesk Entity -> BlueDolphin Object (CREATE, UPDATE) template, you are navigated to the configuration page.
In the 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.
Take the value of the Webhook URL, you need this for webhook configuration on the TOPdesk side. See the attachments at the bottom of the article.
Configuration Fields
Fill in all the details as described in the table,
Section | Field | Description |
Flow Name |
| Template name |
Webhook URL |
| Webhook endpoint |
TOPdesk configuration (Source) |
| NOTE: BlueDolphin supports only known third-party domains. If you use a custom TOPdesk URL, the integration does not work. |
| 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 (Optional) | BlueDolphin ID fields created in TOPdesk. For example, bluedolphin-id.
NOTE: If this optional field is left empty, it will trigger a fallback mechanism to find an object by title next time there is a change in the TOPdesk asset. If the asset name is changed, this may cause the creation of a new object. |
| BlueDolphin Title Field (Optional) | 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. |
Bluedolphin configuration (Target) | API URL | Select the URL from a dropdown for the relevant region. |
| API Key | |
| Business Unit | Select the BlueDolphin business unit/workspace from the drop-down. |
| Object Definition | Select the BlueDolphin Object Definition you want to connect from the drop-down. |
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.