BlueDolphin objects sync to TOPdesk as assets with corresponding templates. An object definition in BlueDolphin represents a template in TOPdesk.

Preparation

Before configuring the integration, create two fields: one in BlueDolphin and one in TOPdesk. The integration uses them to link each BlueDolphin object to its TOPdesk asset. When an object changes in BlueDolphin, the integration uses this link to find and update the right asset in TOPdesk. Example: The object Application Function syncs to TOPdesk. In BlueDolphin, the TOPdesk Asset ID property stores the TOPdesk asset ID. In TOPdesk, the asset's bluedolphin-id field stores the ID of the BlueDolphin object.
You also need a BlueDolphin Public API key.

Step 1: Add the TOPdesk Asset ID property in BlueDolphin

From the main menu, go to Admin. Under Configuration, click Object definitions, then open the object definition you want to sync to TOPdesk (for example, Application Function).
Under the Object properties tab, click Add object properties.
In the Add object property window, fill in the following fields:
1. Field name: Enter TOPdesk Asset ID.
2. Standard value: Leave empty.
3. Questionnaire: Don’t select an option.
Click OK.

Repeat these steps for each object definition you want to sync.

Step 2: Create the bluedolphin-id field in TOPdesk

In TOPdesk, go to Modules > Asset Management.
Open Template Designer.
Open the asset template that matches your BlueDolphin object definition.
Add a field called bluedolphin-id to the template.
Save the template.

Step 3: Create a Public API key in BlueDolphin

NOTE: You must have the Admin role to create an API key.

From the main menu, navigate to Admin.
Under Identity and access, click on Public API keys
Click the icon to create a new key.
Enter
1. Name: for example, TOPdesk integration
2. Scope: User Key Management
3. Expiration date
  You can’t change the expiration date after the key is created.
Copy the key and store it securely. You need it when you configure the integration.
WARNING: Store your API key like a password. Don't share it or take a screenshot of it.
Click Create.

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 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
BlueDolphin configuration (Source)	API URL (Mandatory)	Select the URL from a dropdown for the relevant region.
	API Key (Mandatory)	BlueDolphin API Key: Create new 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.
	Asset ID Field (Mandatory)	Must be set as “TOPdesk Asset ID.” Select the Object property of the selected object definition in BlueDolphin to store the newly created asset's ID.
TOPdesk configuration (Target)	Instance URL (Mandatory)	Address URL from the TOPdesk API. Remove the path part of the URL and trailing slashes. For example: https://your-instance.topdesk.net/tas/api/assetmgmt Should be: https://your-instance.topdesk.net
	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”
	BlueDolphin Title Field (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.

BlueDolphin to TOPdesk Integration