We are planning to launch Confluence Embeds to our customers. At the end of March 2024, we’ll be integrating Embeds as a new content type within Confluence that will exist within the current navigation and creation structures, including the content tree. Users would be able to add an embedded view of a smart link directly from the Create buttons and in the content tree.
Apps that directly use content tree (fka page tree) in their functionality maybe at risk. We would highly urge those app developers to proactively test when the changes are available through DCP in your test tenants.
As we prepare to go live with the upcoming changes, we would like to seek your collaboration in validating and mitigating any potential impact that these changes may have on your applications.
- To facilitate this process, all required changes will be available through this EAP. Join the EAP by raising a ticket here: https://ecosystem.atlassian.net/servicedesk/customer/portal/3282
This will allow you to thoroughly test your applications and report back any impact or issues that you may encounter. We will provide updates to EAP tickets once the requested tenants have joined the EAP.
If your application is impacted by the changes, please comment in the EAP community. We are looking forward to working together with you to resolve any issues before releasing the new content type to our shared customers.
Problem/Opportunity
The fundamental user problem that we are trying to solve - “Teams’ success depends on easily finding and accessing the right information needed to do their work.”
We have a strong belief that users desire a unified platform for all their content across various applications, and Confluence is an absolute right fit to be that connected workspace for users and their team.
Solution
To solve the above problem, we are introducing Embeds as a new content type. Basically any user can add an embedded view of a Smart Link in the content tree. This can be an existing confluence page, a loom recording, a google sheet, figma file, etc.
This would exist as a native content type within Confluence, with functionality and behaviors similar to other existing content types. These include but are not limited to existing in the tree, and being able to be created from the create button.
We will provide important details about this upcoming change and what you need to know as an ecosystem developer.
What is changing in the upcoming release?
In one of the upcoming releases, Embeds will be added to Confluence’s current navigation structure.
Important Note: The changes are very similar to those associated with the introduction of Whiteboards & Databases to Confluence, so it shouldn’t bring any new surprise. ( previous RFCs on Whiteboards RFC-10: Confluence Whiteboards and Databases RFC-23: Confluence Databases ).
Here are the most relevant upcoming changes:
Embeds Creation
- Embeds can be created similarly to pages’ creation mechanism
- Embeds can be created both through the top navigation ‘Create’ button and clicking on “Smart Link”
- Embeds can be created through the “+” button next to Content in the sidebar.
Embeds in the Content Tree
- Embeds will co-exist in the content tree with other content types such as Pages Whiteboards and Databases. They will be able to be parent nodes as well as child nodes
- Content actions including Rename, Copy Link, Copy, Move Archive, and Delete will be available for Embeds
When will this change take place?
The feature will be released to customers in a measured rollout process starting at the end of March 2024 to be completed over 4-5 weeks. Enterprise customers would be able to control the availability of the feature through Release tracks.
How might this affect you?
With the upcoming changes, some of our APIs will be updated to include Embeds-related information in the response. Examples of such APIs are:
- Rest APIs
- Endpoints that return children/descendants and ancestors for a Content that support the following expand parameters will be affected. E.g.
ancestors- will now return Embeds in the response.childTypes.all- this will not be affected immediately but will include Embeds in the future.
- Endpoints under Content - children and descendants will not be affected immediately but we will include Embeds in the response in the future.
/wiki/rest/api/content/{id}/child
/wiki/rest/api/content/{pageId}/move/{position}/{targetId}
/wiki/rest/api/content/{id}/child/{type}
/wiki/rest/api/content/{id}/descendant
/wiki/rest/api/content/{id}/descendant/{type}
/wiki/rest/api/content/{id}/pagehierarchy/copy
/wiki/rest/api/content/{id}/copy - Content body expand will be empty for Embeds
/wiki/rest/api/content/{id}/expand=body.storage
- Endpoints that return children/descendants and ancestors for a Content that support the following expand parameters will be affected. E.g.
- GraphQL APIs
ConfluencePage.ancestor
Note: Support for v2 CRUD APIs for embeds will be available soon!