Add Comment with Twist API on New Notification from GitHub API

Pipedream makes it easy to connect APIs for Twist, GitHub and 2,000+ other apps remarkably fast.

Trigger workflow on

New Notification from the GitHub API

Next, do this

Add Comment with the Twist API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Notification trigger
1. Connect your GitHub account
2. Configure timer
Configure the Add Comment action
1. Connect your Twist account
2. Configure thread_id
3. Configure content
4. Optional- Configure attachments
5. Optional- Configure actions
6. Optional- Configure direct_mentions
7. Optional- Configure direct_group_mentions
8. Optional- Configure recipients
9. Optional- Configure groups
10. Optional- Configure temp_id
11. Optional- Configure mark_thread_position
12. Optional- Configure send_as_integration
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 Notification on GitHub

Description:Emit new events when you received a new notification

Version:0.1.15

Key:github-new-notification

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-polling.mjs";

export default {
  ...common,
  key: "github-new-notification",
  name: "New Notification",
  description: "Emit new events when you received a new notification",
  version: "0.1.15",
  type: "source",
  dedupe: "unique",
  async run() {
    const notifications = await this.github.getFilteredNotifications({
      data: {
        participating: true,
        all: true,
      },
    });

    notifications.map((notification) => {
      this.$emit(notification, {
        id: notification.id,
        summary: `New notification ${notification.id}`,
        ts: Date.parse(notification.created_at),
      });
    });
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

GitHub uses OAuth authentication. When you connect your GitHub account, Pipedream will open a popup window where you can sign into GitHub and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitHub API.

Pipedream requests the following authorization scopes when you connect your account:

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Add Comment on Twist

Description:Adds a new comment to a thread.

Version:0.2.1

Key:twist-add-comment

View on GitHub

Twist Overview#

Twist is a communication app designed for team collaboration, with a focus on organized, threaded conversations. Using the Twist API on Pipedream, you can automate workflows to enhance productivity, streamline communication, and integrate with other tools. From automating notifications to syncing tasks across platforms, the API unlocks valuable use cases for teams needing to stay in sync without the noise of email or less structured chat apps.

Action Code#

// legacy_hash_id: a_a4irNP
import { axios } from "@pipedream/platform";

export default {
  key: "twist-add-comment",
  name: "Add Comment",
  description: "Adds a new comment to a thread.",
  version: "0.2.1",
  type: "action",
  props: {
    twist: {
      type: "app",
      app: "twist",
    },
    thread_id: {
      type: "string",
      description: "The id of the thread to the add the comment on.",
    },
    content: {
      type: "string",
      description: "The content of the new comment. Mentions can be used as `[Name](twist-mention://user_id)` for users or `[Group name](twist-group-mention://group_id)` for groups. Check [limits](https://api.twistapp.com/v3/#limits) for size restrictions for the content.",
    },
    attachments: {
      type: "any",
      description: "List of attachments to the new comment. It must follow the JSON format returned by [attachment#upload](https://api.twistapp.com/v3/#upload-an-attachment).",
      optional: true,
    },
    actions: {
      type: "string",
      description: "List of action to the new comment. More information about the format of the object available at the [add an action button submenu](https://api.twistapp.com/v3/#add-an-action-button).",
      optional: true,
    },
    direct_mentions: {
      type: "any",
      description: "The users that are directly mentioned.",
      optional: true,
    },
    direct_group_mentions: {
      type: "any",
      description: "The groups that are directly mentioned.",
      optional: true,
    },
    recipients: {
      type: "any",
      description: "An array of users (e.g. recipients: `[10000, 10001]`) to notify. It also accepts the strings `EVERYONE` or `EVERYONE_IN_THREAD`, which notifies everyone in the workspace or everyone mentioned in previous posts of this thread. If not provided, `EVERYONE_IN_THREAD` will be used.",
      optional: true,
    },
    groups: {
      type: "any",
      description: "The groups that will be notified.",
      optional: true,
    },
    temp_id: {
      type: "string",
      description: "The temporary id of the comment.",
      optional: true,
    },
    mark_thread_position: {
      type: "boolean",
      description: "By default, the position of the thread is marked.",
      optional: true,
    },
    send_as_integration: {
      type: "boolean",
      description: "Displays the integration as the comment creator.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://api.twistapp.com/v3/#add-comment

    if (!this.thread_id || !this.content) {
      throw new Error("Must provide thread_id, and content parameters.");
    }

    return await axios($, {
      method: "post",
      url: "https://api.twist.com/api/v3/comments/add",
      headers: {
        Authorization: `Bearer ${this.twist.$auth.oauth_access_token}`,
      },
      data: {
        thread_id: this.thread_id,
        content: this.content,
        attachments: this.attachments,
        actions: this.actions,
        direct_mentions: this.direct_mentions,
        direct_group_mentions: this.direct_group_mentions,
        recipients: this.recipients,
        groups: this.groups,
        temp_id: this.temp_id,
        mark_thread_position: this.mark_thread_position,
        send_as_integration: this.send_as_integration,
      },
    });
  },
};

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
Twist	`twist`	`app`	This component uses the Twist app.
thread_id	`thread_id`	`string`	The id of the thread to the add the comment on.
content	`content`	`string`	The content of the new comment. Mentions can be used as `[Name](twist-mention://user_id)` for users or `[Group name](twist-group-mention://group_id)` for groups. Check limits for size restrictions for the content.
attachments	`attachments`	`any`	List of attachments to the new comment. It must follow the JSON format returned by attachment#upload.
actions	`actions`	`string`	List of action to the new comment. More information about the format of the object available at the add an action button submenu.
direct_mentions	`direct_mentions`	`any`	The users that are directly mentioned.
direct_group_mentions	`direct_group_mentions`	`any`	The groups that are directly mentioned.
recipients	`recipients`	`any`	An array of users (e.g. recipients: `[10000, 10001]`) to notify. It also accepts the strings `EVERYONE` or `EVERYONE_IN_THREAD`, which notifies everyone in the workspace or everyone mentioned in previous posts of this thread. If not provided, `EVERYONE_IN_THREAD` will be used.
groups	`groups`	`any`	The groups that will be notified.
temp_id	`temp_id`	`string`	The temporary id of the comment.
mark_thread_position	`mark_thread_position`	`boolean`	By default, the position of the thread is marked.
send_as_integration	`send_as_integration`	`boolean`	Displays the integration as the comment creator.

Action Authentication#

Twist uses OAuth authentication. When you connect your Twist account, Pipedream will open a popup window where you can sign into Twist and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Twist API.

Pipedream requests the following authorization scopes when you connect your account:

user:writeuser:readworkspaces:writeworkspaces:readchannels:removechannels:writechannels:readthreads:removethreads:writethreads:readcomments:removecomments:writecomments:readgroups:removegroups:writegroups:readmessages:removemessages:writemessages:readreactions:removereactions:writereactions:readsearch:readattachments:writeattachments:readnotifications:writenotifications:read

Add Comment with Twist API on New Notification from GitHub API

Pipedream makes it easy to connect APIs for Twist, GitHub and 2,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular