Retrieve all Events with Hookdeck API on New Scraping Completed from WebScraper.IO API

Pipedream makes it easy to connect APIs for Hookdeck, WebScraper.IO and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scraping Completed from the WebScraper.IO API

Next, do this

Retrieve all Events with the Hookdeck 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 WebScraper.IO trigger and Hookdeck action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scraping Completed trigger
1. Connect your WebScraper.IO account
2. Configure timer
Configure the Retrieve all Events action
1. Connect your Hookdeck account
2. Optional- Select one or more Status
3. Optional- Select one or more Events IDs
4. Optional- Select a Destination ID
5. Optional- Select a Source ID
6. Optional- Configure Attempts
7. Optional- Configure Created At Initial Range
8. Optional- Configure Created At Final Range
9. Optional- Select a Order By
10. Optional- Select a Order By Direction
11. Optional- Configure Limit
12. Optional- Configure Additional Properties
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 Scraping Completed on WebScraper.IO

Description:Emit new event when a page scraping job has completed. [See the docs here](https://webscraper.io/documentation/web-scraper-cloud/api)

Version:0.0.1

Key:webscraper_io-new-scraping-completed

View on GitHub

WebScraper.IO Overview#

The WebScraper.IO API allows you to programmatically perform web scraping tasks, extracting structured data from websites. With the API, you can automate the gathering of web content for analysis, monitoring, and integration with other data sources. In Pipedream, you can leverage this API to build workflows that process, analyze, and act on the data you scrape without writing code for backend infrastructure.

Trigger Code#

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

export default {
  ...common,
  key: "webscraper_io-new-scraping-completed",
  name: "New Scraping Completed",
  description: "Emit new event when a page scraping job has completed. [See the docs here](https://webscraper.io/documentation/web-scraper-cloud/api)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async emitHistoricalEvents({ limit }) {
      const jobs = await this.getScrapingJobs();
      if (!(jobs?.length > 0)) {
        return;
      }
      jobs.reverse().slice(0, limit)
        .forEach((job) => this.emitEvent(job));
    },
    isRelevant(job, previousIds) {
      return job.status === "finished" && !previousIds[job.id];
    },
    emitEvent(job) {
      const meta = this.generateMeta(job);
      this.$emit(job, meta);
    },
    generateMeta(job) {
      return {
        id: job.id,
        summary: job.sitemap_name,
        ts: job.time_created,
      };
    },
    async getScrapingJobs() {
      const jobs = [];
      const previousIds = this._getPreviousIds();

      const results = await this.webscraper.paginate(this.webscraper.getScrapingJobs);
      for (const job of results) {
        if (this.isRelevant(job, previousIds)) {
          previousIds[job.id] = true;
          jobs.push(job);
        }
      }

      this._setPreviousIds(previousIds);

      return jobs;
    },
  },
  async run() {
    const jobs = await this.getScrapingJobs();
    jobs.forEach((job) => this.emitEvent(job));
  },
};

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

Trigger Authentication#

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

" To retrieve your API token,

Navigate to your Web Scraper account and sign in
Go to “Account Info” > “API settings”"

About WebScraper.IO#

Making web data extraction easy and accessible for everyone.

Action#

Retrieve all Events on Hookdeck

Description:This endpoint lists all events, or a subset of events. [See the documentation](https://hookdeck.com/api-ref#retrieve-all-events).

Version:0.0.2

Key:hookdeck-retrieve-all-events

View on GitHub

Hookdeck Overview#

The Hookdeck API facilitates the management of webhooks, providing reliable webhook delivery, monitoring, and debugging solutions. With this API on Pipedream, you can automate workflows concerning incoming webhook data—transforming, routing, and ensuring they trigger the subsequent actions without fail. This could range from logging data for analysis, conditionally processing and forwarding webhook events to other endpoints, or integrating with third-party services for extended automation.

Action Code#

import options from "../../common/options.mjs";
import app from "../../hookdeck.app.mjs";

export default {
  name: "Retrieve all Events",
  description: "This endpoint lists all events, or a subset of events. [See the documentation](https://hookdeck.com/api-ref#retrieve-all-events).",
  key: "hookdeck-retrieve-all-events",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    status: {
      propDefinition: [
        app,
        "status",
      ],
    },
    eventId: {
      propDefinition: [
        app,
        "eventId",
      ],
      type: "string[]",
      label: "Events IDs",
      description: "Filter by event IDs.",
    },
    destinationId: {
      propDefinition: [
        app,
        "destinationId",
      ],
      description: "Filter by destination IDs.",
    },
    sourceId: {
      propDefinition: [
        app,
        "sourceId",
      ],
      description: "Filter by source IDs",
    },
    attempts: {
      propDefinition: [
        app,
        "attempts",
      ],
    },
    createdAtInitialRange: {
      propDefinition: [
        app,
        "createdAtInitalRange",
      ],
    },
    createdAtFinalRange: {
      propDefinition: [
        app,
        "createdAtFinalRange",
      ],
    },
    orderBy: {
      propDefinition: [
        app,
        "orderBy",
      ],
      options: options.retrieveRequestEvents.ORDER_BY,
    },
    orderByDir: {
      propDefinition: [
        app,
        "orderByDir",
      ],
    },
    limit: {
      propDefinition: [
        app,
        "limit",
      ],
    },
    additionalProperties: {
      propDefinition: [
        app,
        "additionalProperties",
      ],
    },
  },
  async run({ $ }) {
    const MAX_RESULTS = this.limit ?? 1000;
    const data = [];
    let nextCursor = null;

    while (true) {
      const {
        models,
        pagination,
      } = await this.app.listEvents({
        "status": this.status,
        "id": this.eventId,
        "destination_id": this.destinationId,
        "source_id": this.sourceId,
        "attempts": this.attempts,
        "created_at[gte]": this.createdAtInitialRange,
        "created_at[lte]": this.createdAtFinalRange,
        "order_by": this.orderBy,
        "dir": this.orderByDir,
        ...this.additionalProperties,
      }, $);

      data.push(...models);
      nextCursor = pagination.next;

      if (!nextCursor || data.length >= MAX_RESULTS) {
        break;
      }
    }

    if (data.length > 0) {
      $.export("summary", `Successfully fetched ${data.length} event(s)`);
    } else {
      $.export("summary", "No events found");
    }
    return data.splice(0, MAX_RESULTS);
  },
};

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
Hookdeck	`app`	`app`	This component uses the Hookdeck app.
Status	`status`	`string[]`	Select a value from the drop down menu:`SCHEDULEDQUEUEDHOLDSUCCESSFULFAILED`
Events IDs	`eventId`	`string[]`	Select a value from the drop down menu.
Destination ID	`destinationId`	`string`	Select a value from the drop down menu.
Source ID	`sourceId`	`string`	Select a value from the drop down menu.
Attempts	`attempts`	`integer`	Filter by number of attempts.
Created At Initial Range	`createdAtInitialRange`	`string`	Filter by created at initial range. `YYYY-MM-DD` format.
Created At Final Range	`createdAtFinalRange`	`string`	Filter by created at final range. `YYYY-MM-DD` format.
Order By	`orderBy`	`string`	Select a value from the drop down menu:`last_attempt_atcreated_at`
Order By Direction	`orderByDir`	`string`	Select a value from the drop down menu:`ascdesc`
Limit	`limit`	`integer`	Limit the number of results. Pipedream will automatically paginate through the results.
Additional Properties	`additionalProperties`	`object`	Filter by additional properties. Check the documentation