Update a Post with Confluence API on New Package Version from npm API

Pipedream makes it easy to connect APIs for Confluence, npm and 2,200+ other apps remarkably fast.

Trigger workflow on

New Package Version from the npm API

Next, do this

Update a Post with the Confluence API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a npm trigger and Confluence action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Update a Post action
1. Connect your Confluence account
2. Select a Post ID
3. Optional- Select a Space Id
4. Optional- Select a Status
5. Optional- Configure Title
6. Optional- Configure Body
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Update a Post on Confluence

Description:Updates a page or blog post on Confluence by its ID. [See the documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post/#api-blogposts-id-put)

Version:0.0.1

Key:confluence-update-post

View on GitHub

Confluence Overview#

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.

Action Code#

import confluence from "../../confluence.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "confluence-update-post",
  name: "Update a Post",
  description: "Updates a page or blog post on Confluence by its ID. [See the documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post/#api-blogposts-id-put)",
  version: "0.0.1",
  type: "action",
  props: {
    confluence,
    postId: {
      propDefinition: [
        confluence,
        "postId",
      ],
    },
    spaceId: {
      propDefinition: [
        confluence,
        "spaceId",
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        confluence,
        "status",
      ],
    },
    title: {
      propDefinition: [
        confluence,
        "title",
      ],
      optional: true,
    },
    body: {
      propDefinition: [
        confluence,
        "body",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const cloudId = await this.confluence.getCloudId({
      $,
    });
    const post = await this.confluence.getPost({
      $,
      cloudId,
      postId: this.postId,
      params: {
        "body-format": "storage",
      },
    });
    if (!Object.keys(post.body).length && !this.body) {
      throw new ConfigurationError("Must contain Body");
    }
    const representation = Object.keys(post.body)[0];
    const value = post.body[representation].value;
    const version = post.version.number;
    const response = await this.confluence.updatePost({
      $,
      cloudId,
      postId: this.postId,
      data: {
        id: this.postId,
        status: this.status || post.status,
        title: this.title || post.title,
        body: {
          representation: this.body
            ? "storage"
            : representation,
          value: this.body || value,
        },
        version: {
          number: version + 1,
        },
      },
    });
    $.export("$summary", `Successfully updated post with ID: ${this.postId}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Confluence	`confluence`	`app`	This component uses the Confluence app.
Post ID	`postId`	`string`	Select a value from the drop down menu.
Space Id	`spaceId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`currentdraft`
Title	`title`	`string`	Title of the blog post, required if creating non-draft.
Body	`body`	`string`	Body of the blog post

Action Authentication#

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-contentread:confluence-space.summarywrite:confluence-spacewrite:confluence-fileread:confluence-propswrite:confluence-propsmanage:confluence-configurationread:confluence-content.allread:confluence-content.summarysearch:confluenceread:meoffline_accessread:space:confluenceread:blogpost:confluencewrite:blogpost:confluencedelete:blogpost:confluenceread:page:confluencewrite:page:confluencedelete:page:confluence