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 like to be sourced from TOPdesk.
NOTE: Integration does not support relationships and it is unidirectional flowing data from TOPdesk to 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 TOPdesk API
- TOPdesk API User - TOPdesk credentials with appropriate access via TOPdesk API
Minimum appropriate access is an operator account with read and update rights on the asset template you want to synchronize. If person, persongroup, operator, operatorgroup 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 for the BlueDolphin
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 (Optional) |
BlueDolphin ID fields created in TOPdesk. For example, bluedolphin-id. |
|
(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. |
|
API URL |
BlueDolphin API URL For US tenants: |
|
Tenant Name | Your tenant name can be found in the BlueDolphin URL behind "app/" or under Admin-> General field ->Database |
|
API Key | Create new 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.
Comments
0 comments
Please sign in to leave a comment.