← Hookdeck

Retrieve all Events with Hookdeck API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Retrieve all Events with the Hookdeck API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Retrieve all Events with Hookdeck API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Hookdeck
 
Try it
Retrieve all Events with Hookdeck API on New Submission from Typeform API
Typeform + Hookdeck
 
Try it
Retrieve all Events with Hookdeck API on Custom Events from Zoom API
Zoom + Hookdeck
 
Try it
Retrieve all Events with Hookdeck API on New Submission (Instant) from Jotform API
Jotform + Hookdeck
 
Try it
Retrieve all Events 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 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.1
Key:hookdeck-retrieve-all-events

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.1",
  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);
  },
};

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.
LabelPropTypeDescription
HookdeckappappThis component uses the Hookdeck app.
Statusstatusstring[]Select a value from the drop down menu:SCHEDULEDQUEUEDHOLDSUCCESSFULFAILED
Events IDseventIdstring[]Select a value from the drop down menu.
Destination IDdestinationIdstringSelect a value from the drop down menu.
Source IDsourceIdstringSelect a value from the drop down menu.
Attemptsattemptsinteger

Filter by number of attempts.

Created At Initial RangecreatedAtInitialRangestring

Filter by created at initial range. YYYY-MM-DD format.

Created At Final RangecreatedAtFinalRangestring

Filter by created at final range. YYYY-MM-DD format.

Order ByorderBystringSelect a value from the drop down menu:last_attempt_atcreated_at
Order By DirectionorderByDirstringSelect a value from the drop down menu:ascdesc
Limitlimitinteger

Limit the number of results. Pipedream will automatically paginate through the results.

Additional PropertiesadditionalPropertiesobject

Filter by additional properties. Check the documentation.

Authentication

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

Sign in and copy your API key from your Dashboard's Workspace Secrets tab.

About Hookdeck

Never miss a webhook again. Our reliable webhook infrastructure gives you full visibility over your webhooks.

More Ways to Use Hookdeck

Triggers

New Event Received (Instant) from the Hookdeck API

Emit new event when a new event is received from a HookDeck source.

 
Try it

Actions

Create Connection with the Hookdeck API

This endpoint creates a connection. See the documentation.

 
Try it
Retrieve all Requests with the Hookdeck API

This endpoint lists all request, or a subset of requests. Requests are sorted by ingested_at date. See the documentation.

 
Try it
Retrieve Request Events with the Hookdeck API

This endpoint retries the events associated with a request. See the documentation.

 
Try it

Explore Other Apps

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.