View as Markdown
Hookdeck icon

Hookdeck ACTION

Retrieve all Requests

This endpoint lists all request, or a subset of requests. Requests are sorted by ingested_at date. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hookdeck account once, then configure and run Retrieve all Requests from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "hookdeck-retrieve-all-requests",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hookdeck: { authProvisionId: "apn_xxxxxxx" },
    id: ["Request ID"],
    status: "Status",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Retrieve all Requests inputs
Property Type Description
id Request ID string[]
Filter by requests IDs.
Optional
status Status string
Filter by status.
Optional
rejectionCause Rejection Cause string
Filter by rejection cause.
Optional
sourceId Source ID string
Filter by source IDs.
Optional Dynamic
path Path string
URL Encoded string of the value to match partially to the path.
Optional
ingestedAtInitialRange Ingested At Initial Range string
Filter by ingested at initial range. YYYY-MM-DD format.
Optional
ingestedAtFinalRange Ingested At Final Range string
Filter by ingested at final range. YYYY-MM-DD format.
Optional
orderBy Order By string
Sort key.
Optional
orderByDir Order By Direction string
Sort direction.
Optional
limit Limit integer
Limit the number of results. Pipedream will automatically paginate through the results.
Optional
additionalProperties Additional Properties object
Filter by additional properties. Check the documentation for more details.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
hookdeck-retrieve-all-requests
Version
0.0.2
App
Hookdeck
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes