Connect tutorials and guides

Connect tutorials

These tutorials help you learn how to develop with Connect on Confluence Cloud.

The basics

These tutorials get you familiar with the basic concepts:

• Getting started
  Get your development site set up, install Atlassian Connect Express, and get started with a basic "Hello, world" app
• Using the REST API
  Get familiar with three ways to call the REST API: using cURL, from a Connect route handler, and from a Connect view
• Creating a general page
  Display content using a generalPages module
• Creating a dynamic content macro
  Use a dynamicContentMacros module to create a dynamic content macro, calling an external API that displays pictures of cute dogs
• Working with a macro body
  Create a dynamic content macro and use the Get macro body by macro ID endpoint to retrieve the macro body
• Using webhooks
  Make your app responsive to Confluence events
• Creating a form
  Create a form macro that stores submissions in content properties

Content byline item

These tutorials show you how to work with the content byline item, the area under a page title that includes information about the latest version of the content:

• Creating a content byline item
  Use the contentBylineItems module to build a simple content byline item
• Changing a byline dynamically
  Use Connect to update the content byline item by changing the byline-ui value

Custom content

These tutorials walk you through building a content application that exposes to new content types, customers and notes:

• Adding a custom content type
  Use the customContent module to set up a new custom content type for storing information about customers
• Working with custom content
  Create instances of a custom content type
• Searching custom content
  Make the new custom content type searchable
• Working with custom content children
  Add a new custom content type as a child of another type

Multi-page blueprints

This tutorial shows how to use a Connect app to build templates for creating content:

• Multi-page blueprints with Confluence Connect
  Use the blueprints module to build a template that helps you create pages more easily

Guides

Connect troubleshooting guide

Macro autoconvert with Confluence Connect

Macro custom editor with Confluence Connect