Retrieve all Requests with Hookdeck API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Retrieve all Requests 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#

Create a workflow to Retrieve all Requests with the Hookdeck API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Retrieve all Requests action
1. Connect your Hookdeck account
2. Optional- Configure Request ID
3. Optional- Select a Status
4. Optional- Select a Rejection Cause
5. Optional- Select a Source ID
6. Optional- Configure Path
7. Optional- Configure Ingested At Initial Range
8. Optional- Configure Ingested 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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Retrieve all Requests with Hookdeck API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Hookdeck

Try it

Retrieve all Requests with Hookdeck API on New Submission from Typeform API

Typeform + Hookdeck

Try it

Retrieve all Requests with Hookdeck API on Custom Events from Zoom API

Zoom + Hookdeck

Try it

Retrieve all Requests with Hookdeck API on New Submission (Instant) from Jotform API

Jotform + Hookdeck

Try it

Retrieve all Requests with Hookdeck API on New Scheduled Tasks from Pipedream API

Pipedream + Hookdeck

Try it

Details#

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

Retrieve all Requests on Hookdeck

Description:This endpoint lists all request, or a subset of requests. Requests are sorted by `ingested_at` date. [See the documentation](https://hookdeck.com/api-ref#retrieve-all-requests).

Version:0.0.1

Key:hookdeck-retrieve-all-requests

View on GitHub

Code#

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

export default {
  name: "Retrieve all Requests",
  description: "This endpoint lists all request, or a subset of requests. Requests are sorted by `ingested_at` date. [See the documentation](https://hookdeck.com/api-ref#retrieve-all-requests).",
  key: "hookdeck-retrieve-all-requests",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    id: {
      type: "string[]",
      label: "Request ID",
      description: "Filter by requests IDs.",
      optional: true,
    },
    status: {
      propDefinition: [
        app,
        "status",
      ],
      type: "string",
      options: options.retrieveAllRequests.STATUS,
    },
    rejectionCause: {
      type: "string",
      label: "Rejection Cause",
      description: "Filter by rejection cause.",
      optional: true,
      options: options.retrieveAllRequests.REJECTION_CAUSE,
    },
    sourceId: {
      propDefinition: [
        app,
        "sourceId",
      ],
      description: "Filter by source IDs.",
    },
    path: {
      type: "string",
      label: "Path",
      description: "URL Encoded string of the value to match partially to the path.",
      optional: true,
    },
    ingestedAtInitialRange: {
      type: "string",
      label: "Ingested At Initial Range",
      description: "Filter by ingested at initial range. `YYYY-MM-DD` format.",
      optional: true,
    },
    ingestedAtFinalRange: {
      type: "string",
      label: "Ingested At Final Range",
      description: "Filter by ingested at final range. `YYYY-MM-DD` format.",
      optional: true,
    },
    orderBy: {
      propDefinition: [
        app,
        "orderBy",
      ],
    },
    orderByDir: {
      propDefinition: [
        app,
        "orderByDir",
      ],
    },
    limit: {
      propDefinition: [
        app,
        "limit",
      ],
    },
    additionalProperties: {
      propDefinition: [
        app,
        "additionalProperties",
      ],
      description: "Filter by additional properties. Check the [documentation](https://hookdeck.com/api-ref#retrieve-all-requests) for more details.",
    },
  },
  async run({ $ }) {
    const MAX_RESULTS = this.limit ?? 1000;
    const data = [];
    let nextCursor = null;

    while (true) {
      const {
        models,
        pagination,
      } = await this.app.listRequests({
        "status": this.status,
        "rejection_cause": this.rejectionCause,
        "source_id": this.sourceId,
        "path": this.path,
        "ingested_at[gte]": this.ingestedAtInitialRange,
        "ingested_at[lte]": this.ingestedAtFinalRange,
        "order_by": this.orderBy,
        "dir": this.orderByDir,
        "next": nextCursor,
        ...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} request(s)`);
    } else {
      $.export("summary", "No requests found");
    }
    return data.splice(0, MAX_RESULTS);
  },
};

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
Hookdeck	`app`	`app`	This component uses the Hookdeck app.
Request ID	`id`	`string[]`	Filter by requests IDs.
Status	`status`	`string`	Select a value from the drop down menu:`acceptedrejected`
Rejection Cause	`rejectionCause`	`string`	Select a value from the drop down menu:`SOURCE_ARCHIVEDNO_WEBHOOKVERIFICATION_FAILEDUNSUPPORTED_HTTP_METHODUNSUPPORTED_CONTENT_TYPEUNPARSABLE_JSONPAYLOAD_TOO_LARGEINGESTION_FATALUNKNOWN`
Source ID	`sourceId`	`string`	Select a value from the drop down menu.
Path	`path`	`string`	URL Encoded string of the value to match partially to the path.
Ingested At Initial Range	`ingestedAtInitialRange`	`string`	Filter by ingested at initial range. `YYYY-MM-DD` format.
Ingested At Final Range	`ingestedAtFinalRange`	`string`	Filter by ingested at final range. `YYYY-MM-DD` format.
Order By	`orderBy`	`string`	Select a value from the drop down menu:`ingested_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 for more details.