The Confluence API allows you to harness the collaborative power of Confluence programmatically. With it, you can automate content creation, update pages, manage spaces, and extract data for reporting or integration with other tools. Leveraging this API within Pipedream enables streamlined workflows that can react to events or schedule tasks, interacting with Confluence data and connecting to an array of other apps and services.
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
confluence: {
type: "app",
app: "confluence",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://api.atlassian.com/me`,
headers: {
Authorization: `Bearer ${this.confluence.$auth.oauth_access_token}`,
},
})
},
})
Automated Content Management: Trigger a workflow when a new Jira ticket is created to generate a Confluence page pre-populated with the ticket details. This page can then be linked back to the Jira ticket, ensuring that documentation is initiated from the outset of a project.
Team Onboarding: Onboard new team members by creating a personalized Confluence space with essential reading and tasks when a new user is added to your HR system, like BambooHR. You could also set up reminders to check in on their progress by sending follow-up emails after a set period.
Meeting Minute Distribution: After a meeting is concluded in a tool like Zoom, automatically create a Confluence page using the meeting notes and distribute it to attendees via Slack or email, ensuring everyone has access to the discussed points and action items.
Creates a new page or blog post on Confluence. See the documentation
Removes a blog post from Confluence by its ID. Use with caution, the action is irreversible. See the documentation
Updates a page or blog post on Confluence by its ID. See the documentation
Confluence uses OAuth authentication. When you connect your Confluence account, Pipedream will open a popup window where you can sign into Confluence and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Confluence API.
Pipedream requests the following authorization scopes when you connect your account:
write:confluence-content
read:confluence-space.summary
write:confluence-space
write:confluence-file
read:confluence-props
write:confluence-props
manage:confluence-configuration
read:confluence-content.all
read:confluence-content.summary
search:confluence
read:me
offline_access
read:space:confluence
read:blogpost:confluence
write:blogpost:confluence
delete:blogpost:confluence
read:page:confluence
write:page:confluence
delete:page:confluence
GET
https://auth.atlassian.com/authorize
?
client_id={{oauth.client_id}}
&
state={{oauth.state}}
&
redirect_uri={{oauth.redirect_uri}}
&
response_type=code
&
scope={{oauth.space_separated_scopes}}
&
audience=api.atlassian.com
&
prompt=consent
POST
https://auth.atlassian.com/oauth/token
content-type: application/x-www-form-urlencoded
accept: application/json
client_id={{oauth.client_id}}
&
client_secret={{oauth.client_secret}}
&
grant_type=authorization_code
&
code={{oauth.code}}
&
redirect_uri={{oauth.redirect_uri}}
POST
https://auth.atlassian.com/oauth/token
content-type: application/x-www-form-urlencoded
accept: application/json
client_id={{oauth.client_id}}
&
client_secret={{oauth.client_secret}}
&
grant_type=refresh_token
&
refresh_token={{oauth.refresh_token}}