BlueDolphin objects are synced to TOPdesk as assets with their respective templates. An object definition in BlueDolphin represents a template in TOPdesk.
NOTE: To store an asset ID in BlueDolphin that will be used to update an asset after creation, a dedicated property called TOPdesk Asset ID must be created.
Make sure that values in BlueDolphin and Topdesk are configured consistently to avoid possible conflicts. When TOPdesk’s template has required fields, BlueDolphin needs to supply those fields. Otherwise, synchronization will fail.
If the number of decimal places does not match between BlueDolphin and Topdesk, the system will either round the number or append zeroes to align them.
If a text field in BlueDolphin exceeds the configured character limit in Topdesk, the system will discard the text without truncating it.
Configuration to be added from the BlueDolphin
Once you install the Template name - BIF: BlueDolphin Entity -> BlueDolphin Object (CREATE, UPDATE) template, you are navigated to the configuration page.
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 BlueDolphin Object Type properties or questionnaire fields to the TOPdesk Template fields.
NOTE: Both Object_Id and Asset Id must be included. Make sure to select the second Asset ID, as it corresponds to the asset name. The first asset ID is a UUID.Click Activate in the bottom right corner.
Configure webhook.
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 Create a subscription article for more information
General Configuration Fields
Fill in all the details as described in the table,
Section | Field | Description |
Flow Name |
| Template name - BIF: BlueDolphin Entity -> BlueDolphin Object (CREATE, UPDATE) |
Webhook URL |
| BlueDolphin webhook endpoint |
General Configuration | API URL | BlueDolphin API URL. The URL must not end on a “/”. For US tenants: |
| Tenant Name | Your tenant name can be found in the BlueDolphin URL behind "app/" |
| API Key | BlueDolphin API Key: Create new API Key |
| Asset ID | Object property in BlueDolphin to store the newly created asset's ID in BlueDolphin. By default, it must be set as “TOPdesk Asset ID”. |
| 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. |
| Instance URL | Address URL from the TOPdesk API. The URL must not end on a “/”. For example, https://valueblue-presales.topdesk.net |
| 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) | This field needs to be empty. |
|
(Mandatory) | This field needs to be empty. |
From TopDesk to BlueDolphin, refer to the TOPdesk Configuration article.