Skip to content

Commit 90911db

Browse files
docs: improve confluence docs (#5049)
## Describe the problem and your solution - Improve confluence docs and other minor cleanups. <!-- Issue ticket number and link (if applicable) --> <!-- Testing instructions (skip if just adding/editing providers) --> <!-- Summary by @propel-code-bot --> --- **Refined Confluence integration docs and added OAuth token guidance** Restructures the Confluence integration documentation into a tabbed layout that emphasizes quickstart steps, OAuth setup, and refreshed guidance on `connectionConfig.cloudId`, including the new `read:page:confluence` scope and a clearer explanation of multi-site domain handling. Adds a Facebook OAuth note about 60-day token expiry, updates the companion setup guide, and replaces the `packages/webapp/public/images/template-logos/apollo.svg` asset with a higher-contrast yellow version. <details> <summary><strong>Key Changes</strong></summary> • Overhauled `docs/integrations/all/confluence.mdx` to a tabbed quickstart with updated sample requests and expanded `cloudId`/domain selection guidance. • Simplified `docs/api-integrations/confluence/how-to-register-your-own-confluence-api-oauth-app.mdx` by removing the prerequisites table and clarifying scope selection and multi-site behavior. • Documented Facebook token refresh limitations in `docs/api-integrations/facebook/how-to-register-your-own-facebook-api-oauth-app.mdx` and `docs/integrations/all/facebook.mdx`. • Swapped `packages/webapp/public/images/template-logos/apollo.svg` for a yellow variant to improve visibility. </details> <details> <summary><strong>Affected Areas</strong></summary> • docs/integrations/all/confluence.mdx • docs/api-integrations/confluence/how-to-register-your-own-confluence-api-oauth-app.mdx • docs/api-integrations/facebook/how-to-register-your-own-facebook-api-oauth-app.mdx • docs/integrations/all/facebook.mdx • packages/webapp/public/images/template-logos/apollo.svg </details> --- *This summary was automatically generated by @propel-code-bot*
1 parent f09aa5b commit 90911db

File tree

5 files changed

+15
-16
lines changed

5 files changed

+15
-16
lines changed
13.1 KB
Loading

docs/api-integrations/confluence/how-to-register-your-own-confluence-api-oauth-app.mdx

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,6 @@ description: 'Register an OAuth app with Confluence and obtain credentials to co
66

77
This guide shows you how to register your own app with Confluence (Atlassian) to obtain your OAuth credentials (client id & secret). These are required to let your users grant your app access to their Confluence account.
88

9-
## Access requirements
10-
11-
Free Atlassian developer account available - no paid account required. App review is only required if you want to list your app on the Atlassian Marketplace.
12-
13-
| Pre-Requisites | Status | Comment|
14-
| - | - | - |
15-
| Paid dev account | ✅ Not required | Free, self-signup for an [Atlassian developer account](https://developer.atlassian.com/). |
16-
| Paid test account | ✅ Not required | Free Confluence Cloud instance can be used for testing. |
17-
| Partnership | ✅ Not required | |
18-
| App review | ⚠️ Conditional | Required only if you want to list your app on the Atlassian Marketplace. |
19-
| Security audit | ✅ Not required | |
20-
21-
## Setup guide
22-
239
<Steps>
2410
<Step title="Create an Atlassian developer account">
2511
If you don't already have one, sign up for an [Atlassian developer account](https://id.atlassian.com/signup/).
@@ -46,6 +32,7 @@ Free Atlassian developer account available - no paid account required. App revie
4632
- `write:confluence-content` - Create and update content
4733
- `delete:confluence-content` - Delete content
4834
- `manage:confluence-configuration` - Manage Confluence instance settings
35+
- `read:page:confluence` - Read Confluence pages
4936
- `offline_access` - Get refresh tokens (required for long-term access)
5037
4. Click **Save** to save your changes.
5138
</Step>
@@ -75,10 +62,18 @@ When working with the Confluence API through Nango, keep these important points
7562
To allow the possibility of refreshing the token, you must add `offline_access` to your scopes when creating the integration on the Nango UI.
7663

7764
**Cloud ID and domain configuration:**
65+
A single Confluence OAuth token can be valid for multiple Atlassian sites. For example, the same token might grant access to both "nango-hq.atlassian.net" and "nango-test.atlassian.net". This is why specifying the `domain` during connection creation is important if you need to connect to a specific site.
66+
7867
When connecting to Confluence, you have two options for specifying which Confluence site to connect to:
7968
1. Provide a `domain` during connection creation (recommended): This ensures you connect to the specific Confluence site you want.
8069
2. Let Nango auto-select the first available site (legacy behavior): If no baseUrl is specified, Nango will use the first site from the accessible resources api.
8170

71+
The connection process works as follows:
72+
1. Nango fetches all accessible sites for the OAuth token
73+
2. If you specified a `domain`, Nango finds the matching site and sets its `cloudId`
74+
3. If no `domain` is specified, Nango uses the first available site and sets its `cloudId`
75+
4. The selected site's `cloudId` and `domain` are stored in the connection configuration
76+
8277
You will need to fetch your Cloud ID to be able to make API requests to the Confluence API. You can do this with the proxy by calling:
8378

8479
```ts

docs/api-integrations/facebook/how-to-register-your-own-facebook-api-oauth-app.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,7 @@ This guide shows you how to register your own app with Facebook to obtain your O
4444
</Steps>
4545

4646
For more details, see [Facebook's OAuth documentation](https://developers.facebook.com/docs/facebook-login/guides/advanced/manual-flow#confirm) and [how to create an application](https://developers.facebook.com/docs/development/create-an-app/).
47+
48+
## Important notes for Facebook API
49+
50+
- Facebook tokens expire after 60 days and cannot be refreshed. Once a token expires, users must re-authenticate by [re-authorizing the connection](/implementation-guides/api-auth/implement-api-auth#6-re-authorize-an-existing-connection).

docs/integrations/all/facebook.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ import { StatusWidget } from "/snippets/api-down-watch/status-widget.jsx"
120120
<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/facebook.mdx)</Note>
121121
</Tab>
122122
<Tab title="🚨 API gotchas">
123-
_No reported gotchas._
123+
- Facebook tokens expire after 60 days and cannot be refreshed. Once a token expires, users must re-authenticate by [re-authorizing the connection](/implementation-guides/api-auth/implement-api-auth#6-re-authorize-an-existing-connection).
124124

125125
<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/facebook.mdx)</Note>
126126
</Tab>
Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)