Advanced Search with Twitter API on New Branch (Instant) from GitHub API

Pipedream makes it easy to connect APIs for Twitter, GitHub and 1000+ other apps remarkably fast.

Trigger workflow on

New Branch (Instant) from the GitHub API

Next, do this

Advanced Search with the Twitter API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Branch (Instant) trigger
1. Connect your GitHub account
2. Select a Repo
Configure the Advanced Search action
1. Connect your Twitter account
2. Configure Search Term
3. Optional- Select a Result Type
4. Optional- Select a Retweets
5. Optional- Select a Replies
6. Optional- Select one or more Languages
7. Optional- Configure Locale
8. Optional- Configure Geocode
9. Optional- Configure Since ID
10. Optional- Configure Enrich Tweets
11. Optional- Configure Count (advanced)
12. Optional- Configure Max API Requests per Execution (advanced)
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 Branch (Instant) on GitHub

Description:Emit new events when a new branch is created

Version:0.0.6

Key:github-new-branch

View on GitHub

Trigger Code#

const common = require("../common-webhook.js");
const eventTypes = [
  "branch",
];

module.exports = {
  ...common,
  key: "github-new-branch",
  name: "New Branch (Instant)",
  description: "Emit new events when a new branch is created",
  version: "0.0.6",
  dedupe: "unique",
  type: "source",
  methods: {
    getEventNames() {
      return [
        "create",
      ];
    },
    generateMeta(data) {
      const ts = Date.now();
      return {
        id: `${data.repository.id}${ts}`,
        summary: `New Branch: ${data.ref} by ${data.sender.login}`,
        ts,
      };
    },
    emitEvent(body) {
      if (eventTypes.indexOf(body.ref_type) > -1) {
        const meta = this.generateMeta(body);
        this.$emit(body, meta);
      }
    },
  },
};

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.
Repo	`repoFullName`	`string`	Select a value from the drop down menu.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
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#

Advanced Search on Twitter

Description:Return Tweets that matches your search criteria. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets)

Version:0.0.4

Key:twitter-advanced-search

View on GitHub

Action Code#

import twitter from "../../twitter.app.mjs";

export default {
  key: "twitter-advanced-search",
  name: "Advanced Search",
  description: "Return Tweets that matches your search criteria. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets)",
  version: "0.0.4",
  type: "action",
  props: {
    db: "$.service.db",
    twitter,
    q: {
      propDefinition: [
        twitter,
        "q",
      ],
    },
    resultType: {
      propDefinition: [
        twitter,
        "resultType",
      ],
    },
    includeRetweets: {
      propDefinition: [
        twitter,
        "includeRetweets",
      ],
    },
    includeReplies: {
      propDefinition: [
        twitter,
        "includeReplies",
      ],
    },
    lang: {
      propDefinition: [
        twitter,
        "lang",
      ],
    },
    locale: {
      propDefinition: [
        twitter,
        "locale",
      ],
    },
    geocode: {
      propDefinition: [
        twitter,
        "geocode",
      ],
    },
    sinceId: {
      propDefinition: [
        twitter,
        "sinceId",
      ],
    },
    enrichTweets: {
      propDefinition: [
        twitter,
        "enrichTweets",
      ],
    },
    count: {
      propDefinition: [
        twitter,
        "count",
      ],
    },
    maxRequests: {
      propDefinition: [
        twitter,
        "maxRequests",
      ],
    },
  },
  async run({ $ }) {
    const {
      lang,
      locale,
      geocode,
      resultType,
      enrichTweets,
      includeReplies,
      includeRetweets,
      sinceId,
      maxRequests,
      count,
      q,
    } = this;

    // run paginated search
    const res = await this.twitter.paginatedSearch({
      $,
      q,
      sinceId,
      lang,
      locale,
      geocode,
      resultType,
      enrichTweets,
      includeReplies,
      includeRetweets,
      maxRequests,
      count,
      limitFirstPage: false,
    });
    $.export("$summary", "Search completed successfully");
    return res;
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twitter	`twitter`	`app`	This component uses the Twitter app.
Search Term	`q`	`string`	Search for keywords `star wars`, screen names `@starwars`, or hashtags `#starwars`. You can also use Twitter's standard search operators.
Result Type	`resultType`	`string`	Select a value from the drop down menu:`{ "label": "Recent", "value": "recent" }{ "label": "Popular", "value": "popular" }{ "label": "Mixed", "value": "mixed" }`
Retweets	`includeRetweets`	`string`	Select a value from the drop down menu:`{ "label": "Include", "value": "include" }{ "label": "Exclude", "value": "exclude" }{ "label": "Only include retweets", "value": "filter" }`
Replies	`includeReplies`	`string`	Select a value from the drop down menu:`{ "label": "Include", "value": "include" }{ "label": "Exclude", "value": "exclude" }{ "label": "Only include replies", "value": "filter" }`
Languages	`lang`	`string[]`	Select a value from the drop down menu.
Locale	`locale`	`string`	Specify the language of the query you are sending (only `ja` is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.
Geocode	`geocode`	`string`	Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by `latitude,longitude,radius`, where radius units must be specified as either `mi` (miles) or `km` (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly.
Since ID	`sinceId`	`string`	Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets that can be accessed through the API. If the limit of Tweets has occurred since the `since_id`, the 'since_id` will be forced to the oldest ID available.
Enrich Tweets	`enrichTweets`	`boolean`	Enrich each Tweet with epoch (milliseconds) and ISO 8601 representations of Twitter's `created_at` timestamp, the Tweet URL, and the profile URL for the author.
Count (advanced)	`count`	`integer`	The maximum number of tweets to return per API request (up to `100`)
Max API Requests per Execution (advanced)	`maxRequests`	`integer`	The maximum number of API requests to make per execution (e.g., multiple requests are required to retrieve paginated results). Note: Twitter rate limits API requests per 15 minute interval.

Action Authentication#

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

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

Advanced Search with Twitter API on New Branch (Instant) from GitHub API

Pipedream makes it easy to connect APIs for Twitter, GitHub and 1000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-12of1000+apps by most popular

1
-
12
of
1000+
apps by most popular