Search Everything with News API API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Search Everything with the News API 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#

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Search Everything action
1. Connect your News API account
2. Configure Query
3. Optional- Select one or more Search In
4. Optional- Select one or more Source IDs
5. Optional- Configure Domains
6. Optional- Configure Exclude Domains
7. Optional- Configure From
8. Optional- Configure To
9. Optional- Select a Language
10. Optional- Select a Sort By
11. 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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Search Everything on News API

Description:Search through millions of articles from over 150,000 large and small news sources and blogs. [See the documentation](https://newsapi.org/docs/endpoints/everything)

Version:0.0.1

Key:news_api-search-everything

View on GitHub

Action Code#

import newsapi from "../../news_api.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "news_api-search-everything",
  name: "Search Everything",
  description: "Search through millions of articles from over 150,000 large and small news sources and blogs. [See the documentation](https://newsapi.org/docs/endpoints/everything)",
  version: "0.0.1",
  type: "action",
  props: {
    newsapi,
    q: {
      propDefinition: [
        newsapi,
        "q",
      ],
    },
    searchin: {
      propDefinition: [
        newsapi,
        "searchin",
      ],
    },
    sourceIds: {
      propDefinition: [
        newsapi,
        "sourceIds",
      ],
    },
    domains: {
      type: "string[]",
      label: "Domains",
      description: "An array of domains to restrict the search to",
      optional: true,
    },
    excludeDomains: {
      type: "string[]",
      label: "Exclude Domains",
      description: "An array of domains to remove from the results",
      optional: true,
    },
    from: {
      type: "string",
      label: "From",
      description: "A date and optional time for the oldest article allowed. This should be in ISO 8601 format (e.g. `2024-11-01` or `2024-11-01T17:27:47`)",
      optional: true,
    },
    to: {
      type: "string",
      label: "To",
      description: "A date and optional time for the newest article allowed. This should be in ISO 8601 format (e.g. `2024-11-01` or `2024-11-01T17:27:47`)",
      optional: true,
    },
    language: {
      propDefinition: [
        newsapi,
        "language",
      ],
    },
    sortBy: {
      propDefinition: [
        newsapi,
        "sortBy",
      ],
    },
    maxResults: {
      propDefinition: [
        newsapi,
        "maxResults",
      ],
    },
  },
  async run({ $ }) {
    const {
      status, articles,
    } = await this.newsapi.searchEverything({
      $,
      params: {
        q: this.q,
        searchin: utils.joinArray(this.searchin),
        sources: utils.joinArray(this.sourceIds),
        domains: utils.joinArray(this.domains),
        excludeDomains: utils.joinArray(this.excludeDomains),
        from: this.from,
        to: this.to,
        language: this.language,
        sortBy: this.sortBy,
        pageSize: this.maxResults,
      },
    });

    if (status === "ok") {
      $.export("$summary", `Successfully retrieved ${articles.length} article${articles.length === 1
        ? ""
        : "s"}`);
    }

    return articles;
  },
};

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
News API	`newsapi`	`app`	This component uses the News API app.
Query	`q`	`string`	Keywords or phrases to search for
Search In	`searchin`	`string[]`	Select a value from the drop down menu:`titledescriptioncontent`
Source IDs	`sourceIds`	`string[]`	Select a value from the drop down menu.
Domains	`domains`	`string[]`	An array of domains to restrict the search to
Exclude Domains	`excludeDomains`	`string[]`	An array of domains to remove from the results
From	`from`	`string`	A date and optional time for the oldest article allowed. This should be in ISO 8601 format (e.g. `2024-11-01` or `2024-11-01T17:27:47`)
To	`to`	`string`	A date and optional time for the newest article allowed. This should be in ISO 8601 format (e.g. `2024-11-01` or `2024-11-01T17:27:47`)
Language	`language`	`string`	Select a value from the drop down menu:`{ "value": "ar", "label": "Arabic" }{ "value": "de", "label": "German" }{ "value": "en", "label": "English" }{ "value": "es", "label": "Spanish" }{ "value": "fr", "label": "French" }{ "value": "he", "label": "Hebrew" }{ "value": "it", "label": "Italian" }{ "value": "nl", "label": "Dutch" }{ "value": "no", "label": "Norwegian" }{ "value": "pt", "label": "Portuguese" }{ "value": "ru", "label": "Russian" }{ "value": "sv", "label": "Swedish" }{ "value": "ud", "label": "Urdu" }{ "value": "zh", "label": "Chinese" }`
Sort By	`sortBy`	`string`	Select a value from the drop down menu:`relevancypopularitypublishedAt`
Max Results	`maxResults`	`integer`	The maximum number of results to return. Must be between 1 and 100.

Action Authentication#

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