BlueDolphin

About the BlueDolphin API

Quick Start Guide

Usage guidelines

Jetmir Abdija

Rutuja Murumkar

BlueDolphin support

API and Integrations

Create a New Data Collector API Key

Uploading a Source

Data Collector

Create an object definition

Enable an object definition

Disable an object definition

Check an object definition for a long-running operation

Update an Object Definition

Retrieve an object definition

Retrieve object definitions

Delete an Object Definition

In BlueDolphin, object definitions are defined and classified based on the ArchiMate specification. By providing a standardized way to define objects, BlueDolphin helps to ensure that all stakeholders have a clear understanding of the enterprise architecture and how its components are related. Below you can find the guidelines for working with the object definitions API.

Object Definitions

Create an Object

Partially update an object

Retrieve an Object

Retrieve Objects

Delete an Object

Delete multiple objects

Objects in BlueDolphin are based on the ArchiMate specification and used as the main building blocks of a process or system. Objects represent a concept or entity, such as a business process, customer, services, or application. Follow the guidelines below for the proper use and integration with the objects API.

Objects

Retrieve a Questionnaire

Retrieve All Questionnaires

Update Dropdown Values on Questionnaire (PUT)

Update Dropdown Values on Questionnaire (POST)

Delete Dropdown Values on Questionnaire

Questionnaires

Create a Relationship

Partially Update a Relationship

Retrieve a Relationship

Delete a Relationship

Delete Multiple Relationships

In BlueDolphin, relationships are based on the ArchiMate specification and they are used to establish different types of relations between objects. Relations API allows you to create, modify, and delete relationships between objects.

Relationships

Introduction to Subscriptions

Create a Subscription

Retrieve a Subscription

Retrieve Subscriptions

Update a Subscription

Delete a Subscription

Subscriptions enable webhook functionality that notifies external services about specific events in BlueDolphin through HTTP requests. You can configure a subscription with a URL endpoint, select the BlueDolphin events to listen for, set headers for authentication, and choose the HTTP verb.

Subscriptions

Create a new User API key

Retrieve API keys for a user

Retrieve API Keys for All Users

Delete an API key

Key Management

Create a user

Retrieve a user

Retrieve users

User Management

Retrieve Workspaces

Workspaces or business units are used to organize content (objects and views) in BlueDolphin. Workspaces are meant to represent different parts or departments of your organization, such as sales and marketing or regional units, such as Company France and Company Portugal. Workspaces API allows you to retrieve the information about existing workspaces for a single tenant, which can then be used to consume other public API endpoints.

Workspaces

Add an Integration in BlueDolphin

TOPdesk to BlueDolphin Integration

BlueDolphin to TOPdesk Integration

ServiceNow to BlueDolphin Integration

BlueDolphin to ServiceNow Integration

JIRA to BlueDolphin Integration

Delete Integration

Integrations

Add BlueDolphin MCP Server to an AI Assistant

Claude to BlueDolphin with MCP

Microsoft Copilot to BlueDolphin with MCP

Trang Le

BlueDolphin MCP (Model Context Protocol) Server connects BlueDolphin to a third-party AI assistant provided, configured, and controlled by the Customer. This allows stakeholders to ask natural language questions and get clear, context-aware answers grounded in BlueDolphin models and data, making enterprise architecture accessible to everyone across the organization. Below you can find the guidelines for connecting BlueDolphin to your AI assistant via the MCP Server API.

MCP Server

Academy

Content Hub

Home

Community

Events

About

Webinars

Privacy & Terms

Newsletter

Contact

LEARN

RESOURCES

COMPANY

Support

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

Try using different keywords or checking for typos.

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

No tickets created by you

No tickets found

Track the progress of all tickets and conversations related to your company.

Customer Portal.

Track the progress of all tickets related to your company.

Tickets portal.

{assigneeName} needs more information from you

Tickets

No access to tickets portal

Search

Skip the search. Describe what you’re trying to do and get a grounded answer.

Browse articles and guides in this topic.

Create your workspace and invite the people you work with.

Set up your account

Build your first workflow and watch it run end to end.

Ship something

Connect the tools your team already uses to bring data in.

Connect your stack

A quick lap of the product so you know where everything lives.

{appName} in 60 seconds

This prototype demo is aware that you are reading “{title}”. It can point you back to the current article, but a production article-aware Fin contract is still follow-up work.

Prototype article-aware answer

Because you already asked about invitations, this prototype demo can add the follow-up: use the role selector before sending each invite to limit access to the teammate responsibilities.

Prototype role-limiting follow-up

This prototype demo suggests starting with your workspace profile, inviting the team members who need access, and then connecting the integrations you use.

Prototype getting-started answer

In this prototype demo, integrations are configured from workspace settings. Choose the integration, connect the account, and review the enabled permissions.

Prototype integrations answer

In this prototype demo, invite teammates from workspace settings, then choose the access each teammate needs before sending the invitation.

Prototype invite-team answer

This prototype demo does not have a scripted answer for that question yet. Try asking how to invite your team or open a source article. No production Fin API was called.

Prototype answer unavailable

I’ve got this page open. Ask me anything about it and I’ll answer from the docs.

Reading along with you

Nederlands

English

url(https://downloads.intercomcdn.com/i/o/whz92vok/752036/18f453bbe8193bac54bb6d6b093a/7500ddedec36d5f783fe5e0022db7210.png)