Create Announcement with LaunchNotes API

Pipedream makes it easy to connect APIs for LaunchNotes and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Announcement with the LaunchNotes 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#

Create a workflow to Create Announcement with the LaunchNotes API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Announcement action
1. Connect your LaunchNotes account
2. Optional- Configure Client Mutation Id
3. Select a Project ID
4. Optional- Configure Headline
5. Optional- Configure Content Markdown
6. Optional- Configure Should Notify Page Subscribers
7. Select one or more Categories
8. Optional- Select a Template Id
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Announcement with LaunchNotes API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + LaunchNotes

Try it

Create Announcement with LaunchNotes API on New Submission from Typeform API

Typeform + LaunchNotes

Try it

Create Announcement with LaunchNotes API on New Submission (Instant) from Jotform API

Jotform + LaunchNotes

Try it

Create Announcement with LaunchNotes API on New Scheduled Tasks from Pipedream API

Pipedream + LaunchNotes

Try it

Create Announcement with LaunchNotes API on New Download Counts from npm API

npm + LaunchNotes

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Announcement on LaunchNotes

Description:Generates a draft announcement for the LaunchNotes project. [See the documentation](https://developer.launchnotes.com/index.html)

Version:0.0.1

Key:launchnotes-create-announcement

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import launchnotes from "../../launchnotes.app.mjs";

export default {
  key: "launchnotes-create-announcement",
  name: "Create Announcement",
  description: "Generates a draft announcement for the LaunchNotes project. [See the documentation](https://developer.launchnotes.com/index.html)",
  version: "0.0.1",
  type: "action",
  props: {
    launchnotes,
    clientMutationId: {
      propDefinition: [
        launchnotes,
        "clientMutationId",
      ],
      optional: true,
    },
    projectId: {
      propDefinition: [
        launchnotes,
        "projectId",
      ],
    },
    headline: {
      type: "string",
      label: "Headline",
      description: "The announcement title.",
      optional: true,
    },
    contentMarkdown: {
      type: "string",
      label: "Content Markdown",
      description: "The Announcement content. Markdown formatting is supported.",
      optional: true,
    },
    shouldNotifyPageSubscribers: {
      type: "boolean",
      label: "Should Notify Page Subscribers",
      description: "Whether the subscribers will be notified or not.",
      optional: true,
    },
    categories: {
      propDefinition: [
        launchnotes,
        "categories",
        ({ projectId }) => ({
          projectId,
        }),
      ],
    },
    templateId: {
      propDefinition: [
        launchnotes,
        "templateId",
        ({ projectId }) => ({
          projectId,
        }),
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      data, errors: responseErrors,
    } = await this.launchnotes.createAnnouncement({
      $,
      variables: {
        input: {
          clientMutationId: this.clientMutationId,
          announcement: {
            projectId: this.projectId,
            headline: this.headline,
            contentMarkdown: this.contentMarkdown,
            shouldNotifyPageSubscribers: this.shouldNotifyPageSubscribers,
            categories: parseObject(this.categories)?.map((item) => ({
              id: item,
            })),
            templateId: this.templateId,
          },
        },
      },
    });

    const errors = responseErrors || data.createAnnouncement.errors;

    if (errors.length) {
      throw new ConfigurationError(JSON.stringify(errors[0]));
    }

    $.export("$summary", `Successfully created draft announcement with Id: ${data.createAnnouncement.announcement.id}`);
    return data;
  },
};

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
LaunchNotes	`launchnotes`	`app`	This component uses the LaunchNotes app.
Client Mutation Id	`clientMutationId`	`string`	A unique identifier for the client performing the mutation.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Headline	`headline`	`string`	The announcement title.
Content Markdown	`contentMarkdown`	`string`	The Announcement content. Markdown formatting is supported.
Should Notify Page Subscribers	`shouldNotifyPageSubscribers`	`boolean`	Whether the subscribers will be notified or not.
Categories	`categories`	`string[]`	Select a value from the drop down menu.
Template Id	`templateId`	`string`	Select a value from the drop down menu.