Search Tweets with X (Twitter) API on New Webhook Event (Instant) from ConvertKit API

Pipedream makes it easy to connect APIs for X (Twitter), ConvertKit and 2,000+ other apps remarkably fast.

Trigger workflow on

New Webhook Event (Instant) from the ConvertKit API

Next, do this

Search Tweets with the X (Twitter) 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 ConvertKit trigger and X (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 Webhook Event (Instant) trigger
1. Connect your ConvertKit account
2. Select a Webhook Events
Configure the Search Tweets action
1. Connect your X (Twitter) account
2. Configure Query
3. Optional- Configure Max Results
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 Webhook Event (Instant) on ConvertKit

Description:Emit new event for each selected event types. [See docs here](https://developers.convertkit.com/#create-a-webhook)

Version:0.0.2

Key:convertkit-webhook-events

View on GitHub

ConvertKit Overview#

ConvertKit's API offers granular control over email marketing campaigns, allowing users to automate subscriber management, broadcast sending, and sequence setup. Utilize Pipedream's power to react to events, sync data across platforms, or create personalized, timely campaigns. Pipedream's serverless platform connects ConvertKit with hundreds of other apps, enabling automated workflows that save time and improve engagement.

Trigger Code#

import common from "../common/common.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "convertkit-webhook-events",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for each selected event types. [See docs here](https://developers.convertkit.com/#create-a-webhook)",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    ...common.props,
    event: {
      label: "Webhook Events",
      description: "The event will be emitted",
      type: "string",
      options: constants.WEBHOOK_EVENTS.map(({
        value, label,
      }) => ({
        value,
        label,
      })),
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    const optionalProps = constants.WEBHOOK_EVENTS
      .find((ev) => this.event === ev.value)?.additionalProps;
    if (optionalProps?.includes("form")) {
      props.form = {
        type: "integer",
        label: "Form",
        description: "Select a form",
        options: async () => {
          const response = await this.convertkit.listForms();
          return response.forms.map((form) => ({
            label: form.name,
            value: form.id,
          }));
        },
      };
    } else if (optionalProps?.includes("course")) {
      props.course = {
        type: "integer",
        label: "Course",
        description: "Select a course",
        options: async () => {
          const response = await this.convertkit.listCourses();
          return response.courses.map((course) => ({
            label: course.name,
            value: course.id,
          }));
        },
      };
    } else if (optionalProps?.includes("initiator")) {
      props.link = {
        type: "string",
        label: "Link",
        description: "link URL",
      };
    } else if (optionalProps?.includes("tag")) {
      props.tag = {
        type: "integer",
        label: "Tag",
        description: "Select a tag",
        options: async () => {
          const response = await this.convertkit.listTags();
          return response.tags.map((tag) => ({
            label: tag.name,
            value: tag.id,
          }));
        },
      };
    }
    return props;
  },
  methods: {
    ...common.methods,
    getWebhookEventTypes() {
      return {
        name: this.event,
        form_id: this.form,
        course_id: this.course,
        initiator_value: this.link,
        tag_id: this.tag,
      };
    },
    async processEvent(event) {
      const {
        headers,
        body,
      } = event;

      this.$emit(body, {
        id: headers.tracestate,
        summary: `New event of type ${constants.WEBHOOK_EVENTS
          .find((ev) => this.event === ev.value).label}`,
        ts: new Date().getTime(),
      });
    },
  },
};

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
ConvertKit	`convertkit`	`app`	This component uses the ConvertKit app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Webhook Events	`event`	`string`	Select a value from the drop down menu:`{ "value": "subscriber.form_subscribe", "label": "On form subscription" }{ "value": "subscriber.course_subscribe", "label": "On course subscription" }{ "value": "subscriber.course_complete", "label": "On course completion" }{ "value": "subscriber.link_click", "label": "On link clicked" }{ "value": "subscriber.tag_add", "label": "On tag added" }{ "value": "subscriber.tag_remove", "label": "On tag removed" }{ "value": "purchase.purchase_create", "label": "On purchase created" }`

Trigger Authentication#

ConvertKit uses API keys for authentication. When you connect your ConvertKit account, Pipedream securely stores the keys so you can easily authenticate to ConvertKit APIs in both code and no-code steps.

All API calls require the api_key parameter. Some API calls require the api_secret parameter. You can find your API Key and Secret in the ConvertKit Account page. See documentation.

About ConvertKit#

Email Marketing for Online Creators

Action#

Search Tweets on X (Twitter)

Description:Retrieve Tweets from the last seven days that match a query. [See the documentation](https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent)

Version:2.0.8

Key:twitter-simple-search

View on GitHub

X (Twitter) Overview#

The Twitter API on Pipedream enables you to automate interactions with Twitter, from posting tweets to analyzing social media trends. Pipedream's serverless platform provides the tools to create workflows that trigger on specific Twitter activities, process data, and connect with countless other apps for extensive automation scenarios. With Pipedream's integration, you can listen for events such as new tweets, mentions, or followers, and execute actions like tweeting, retweeting, or even leveraging sentiment analysis to gauge public perception.

Action Code#

import common from "../../common/appValidation.mjs";
import { ACTION_ERROR_MESSAGE } from "../../common/errorMessage.mjs";
import { defineAction } from "@pipedream/types";
import { getMultiItemSummary, getTweetFields, } from "../../common/methods.mjs";
export const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent";
const MIN_RESULTS = 10;
const DEFAULT_RESULTS = 10;
export const MAX_RESULTS_PER_PAGE = 100;
export default defineAction({
    ...common,
    key: "twitter-simple-search",
    name: "Search Tweets",
    description: `Retrieve Tweets from the last seven days that match a query. [See the documentation](${DOCS_LINK})`,
    version: "2.0.8",
    type: "action",
    props: {
        ...common.props,
        query: {
            propDefinition: [
                common.props.app,
                "query",
            ],
        },
        maxResults: {
            propDefinition: [
                common.props.app,
                "maxResults",
            ],
            min: MIN_RESULTS,
            description: `Maximum amount of items to return. Each request can return up to ${MAX_RESULTS_PER_PAGE} items.`,
            default: DEFAULT_RESULTS,
        },
    },
    methods: {
        ...common.methods,
        getMultiItemSummary,
        getTweetFields,
    },
    async run({ $ }) {
        const params = {
            $,
            maxPerPage: MAX_RESULTS_PER_PAGE,
            maxResults: this.maxResults,
            params: {
                query: this.query,
                ...this.getTweetFields(),
            },
            fallbackError: ACTION_ERROR_MESSAGE,
        };
        const response = await this.app.searchTweets(params);
        $.export("$summary", this.getMultiItemSummary("tweet", response.data?.length));
        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
X (Twitter)	`app`	`app`	This component uses the X (Twitter) app.
Query	`query`	`string`	One query for matching Tweets. See the Twitter API guide on building queries.
Max Results	`maxResults`	`integer`	Maximum amount of items to return. Each request can return up to 100 items.

Action Authentication#

X (Twitter) uses OAuth authentication. When you connect your X (Twitter) account, Pipedream will open a popup window where you can sign into X (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 X (Twitter) API.

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

Search Tweets with X (Twitter) API on New Webhook Event (Instant) from ConvertKit API

Pipedream makes it easy to connect APIs for X (Twitter), ConvertKit 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