← Reddit

New Comments by User from Reddit API

Pipedream makes it easy to connect APIs for Reddit and 700+ other apps remarkably fast.

Trigger workflow on
New Comments by User from the Reddit API
Next, do this
Connect to 700+ APIs using code and no-code building blocks
No credit card required
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Comments by User with Reddit API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Comments by User trigger
    1. Connect your Reddit account
    2. Configure Polling schedule
    3. Configure Username
    4. Optional- Configure Number of parents
    5. Optional- Select a Time filter
    6. Optional- Configure Include subreddit details?
  2. Add steps to connect to 700+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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.

New Comments by User on Reddit
Description:Emit new event each time a user posts a new comment.
Version:0.0.4
Key:reddit-new-comments-by-user

Code

import common from "../common.mjs";
const { reddit } = common.props;

export default {
  ...common,
  type: "source",
  key: "reddit-new-comments-by-user",
  name: "New Comments by User",
  description: "Emit new event each time a user posts a new comment.",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    ...common.props,
    username: {
      propDefinition: [
        reddit,
        "username",
      ],
    },
    numberOfParents: {
      type: "integer",
      label: "Number of parents",
      description:
        "The emitted events will contain the new comment plus the parents of said comment up to the number indicated in this property.",
      optional: true,
      min: 2,
      max: 10,
      default: 2,
    },
    timeFilter: {
      propDefinition: [
        reddit,
        "timeFilter",
      ],
    },
    includeSubredditDetails: {
      propDefinition: [
        reddit,
        "includeSubredditDetails",
      ],
    },
  },
  hooks: {
    async deploy() {
      // Emits sample events on the first run during deploy.
      var redditComments = await this.reddit.getNewUserComments(
        null,
        this.username,
        this.numberOfParents,
        this.timeFilter,
        this.includeSubredditDetails,
        10,
      );
      const { children: comments = [] } = redditComments.data;
      if (comments.length === 0) {
        console.log("No data available, skipping iteration");
        return;
      }
      const { name = this._getBefore() } = comments[0].data;
      this._setBefore(name);
      const {
        cache,
        keys,
      } = this.getAllCommentsData(comments);
      this._setCache(cache);
      this._setKeys(keys);
      comments.reverse().forEach(this.emitRedditEvent);
    },
  },
  methods: {
    ...common.methods,
    generateEventMetadata(redditEvent) {
      return {
        id: redditEvent.data.name,
        summary: redditEvent.data.body,
        ts: redditEvent.data.created,
      };
    },
    async isBeforeValid(before, cache) {
      // verify this comment still exists as a comment by this user
      const res = await this.reddit.getComment(cache[before]);
      const author = res[1]?.data?.children[0]?.data?.author;
      return author === this.username;
    },
    getCommentData(comment) {
      return {
        name: comment?.data?.name,
        id: comment?.data?.id,
        article: comment?.data?.link_id.slice(3),
        subreddit: comment?.data?.subreddit,
      };
    },
    getAllCommentsData(comments) {
      const cache = this._getCache();
      const keys = this._getKeys();
      comments.reverse().forEach((comment) => {
        cache[comment?.data?.name] = this.getCommentData(comment);
        keys.push(comment?.data?.name);
      });
      return {
        cache,
        keys,
      };
    },
  },
  async run() {
    let redditComments;
    const {
      cache: previousEmittedEvents,
      keys,
    } = await this.validateBefore(this._getCache(),
      this._getBefore(),
      this._getKeys());
    do {
      redditComments = await this.reddit.getNewUserComments(
        this._getBefore(),
        this.username,
        this.numberOfParents,
        this.timeFilter,
        this.includeSubredditDetails,
      );
      const { children: comments = [] } = redditComments.data;
      if (comments.length === 0) {
        console.log("No data available, skipping iteration");
        break;
      }
      const { name = this._getBefore() } = comments[0].data;
      this._setBefore(name);

      comments.reverse().forEach((comment) => {
        if (!previousEmittedEvents[comment.data.name]) {
          previousEmittedEvents[comment.data.name] = this.getCommentData(comment);
          keys.push(comment.data.name);
          this.emitRedditEvent(comment);
        }
      });
    } while (redditComments);
    this._setCache(previousEmittedEvents);
    this._setKeys(keys);
  },
};

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.
LabelPropTypeDescription
RedditredditappThis component uses the Reddit app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
Polling scheduletimer$.interface.timer

Pipedream polls Reddit for events on this schedule.

Usernameusernamestring

The username you'd like to watch.

Number of parentsnumberOfParentsinteger

The emitted events will contain the new comment plus the parents of said comment up to the number indicated in this property.

Time filtertimeFilterstringSelect a value from the drop down menu:hourdayweekmonthyearall
Include subreddit details?includeSubredditDetailsboolean

If set to true, subreddit details will be expanded/included.

Authentication

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

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

accountidentityeditflairhistoryreadreportsavestructuredstylessubmitsubscribevoteflairmodflairmodconfigmodflairmodlogmodpostsmodwikimysubredditswikieditwikiread

About Reddit

Reddit is a network of communities based on people's interests. Find communities you're interested in, and become part of an online community!

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday