View as Markdown
Hookdeck icon

Hookdeck ACTION

Retrieve all Events

This endpoint lists all events, or a subset of events. 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 Events 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-events",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hookdeck: { authProvisionId: "apn_xxxxxxx" },
    status: ["Status"],
    eventId: ["Events IDs"],
  },
})

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 Events inputs
Property Type Description
status Status string[]
Filter by status.
Optional
eventId Events IDs string[]
Filter by event IDs.
Optional Dynamic
destinationId Destination ID string
Filter by destination IDs.
Optional Dynamic
sourceId Source ID string
Filter by source IDs
Optional Dynamic
attempts Attempts integer
Filter by number of attempts.
Optional
createdAtInitialRange Created At Initial Range string
Filter by created at initial range. YYYY-MM-DD format.
Optional
createdAtFinalRange Created At Final Range string
Filter by created 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.
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-events
Version
0.0.2
App
Hookdeck
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes