BlueDolphin objects sync to TOPdesk as assets with corresponding templates. An object definition in BlueDolphin represents a template in TOPdesk.
Preparation
Before starting the configuration steps in BlueDolphin, ensure that the following fields are created (or exist):
The TOPdesk Asset ID property in BlueDolphin
A field to store the BlueDolphin Object ID in the asset template in TOPdesk
In BlueDolphin, create a property called TOPdesk Asset ID on the object to store an asset ID for updating an asset after creation. You will supply this property to the Asset ID Field textbox in the BlueDolphin Marketplace interface.
In TOPdesk, create a field called bluedolphin-id on the TOPdesk asset template to store a BlueDolphin Object ID for updating an asset after creation.
Define the BlueDolphin ID Field via Modules->Asset Management->Template Designer in TOPdesk. You will supply this property to the BlueDolphin ID Field textbox in the BlueDolphin Marketplace interface.
NOTE:
Ensure BlueDolphin and TOPdesk values match to avoid conflicts:
If decimal places differ, the system rounds or appends zeroes to align values.
If a BlueDolphin text field exceeds TOPdesk's character limit, the system discards the text without truncation.
Configuration to be added from the BlueDolphin
After installing the template "BIF: BlueDolphin Entity -> BlueDolphin Object (CREATE, UPDATE)", you are directed to the configuration page.
Use the webhook URL, object definition ID, and workspace ID to create a webhook for ObjectCreated and ObjectUpdated events. Refer to the Create a subscription article for more information
In the General Configuration section, complete all the required fields as shown below. Refer to the Configuration Fields table for guidance.
Click Verify and Connect to confirm the connector details.
If successful, “Connected” appears at the bottom, and the Integration Mapping field appears.
In Integration Mapping, map BlueDolphin fields to TOPdesk fields. This creates a one-to-one mapping between BlueDolphin properties or questionnaires and TOPdesk template 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 |
| BIF: BlueDolphin Object → TOPdesk Entity (CREATE, UPDATE) |
Webhook URL |
| BlueDolphin webhook endpoint. Refer to Create a subscription |
General Configuration | API URL | BlueDolphin API URL. For US tenants:
|
| Tenant Name (Mandatory) | Your tenant name can be found in the BlueDolphin URL behind "app/" |
| API Key (Mandatory) | BlueDolphin API Key: Create new API Key |
| Asset ID (Mandatory) | Must be set as “TOPdesk Asset ID” Name of the Object property in BlueDolphin to store the newly created asset's ID. |
| Object Definition ID (Mandatory) | 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 (Mandatory) | 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.
|
| Instance URL (Mandatory) | Address URL from the TOPdesk API. Remove the path part of the URL and trailing slashes.
For example:
|
| User Name (Mandatory) | TOPdesk account name |
| API Key (Mandatory) | TOPdesk API Key |
| Asset type (Mandatory) | Template from TOPdesk you want to connect to BlueDolphin |
| BlueDolphin ID Field (Mandatory) | Asset field ID in TOPdesk where BlueDolphin stores the ID of the BlueDolphin object. By default, it should be “bluedolphin-id” |
|
(Mandatory) | Asset field ID in TOPdesk used by BlueDolphin to discover if an Asset already exists for a given object title. Must be set to the value “name”.
Do not include any integration mappings that map a BlueDolphin Field into “Asset Name” except “object_title” |
From TOPdesk to BlueDolphin, refer to the TOPdesk Configuration article.