Succeeding with HookdeckUsing the CLIUsing the APICompliance and security

Using the CLI

Hookdeck CLI lets you forward webhooks received on any connection to a local web server.

Why use the CLI

With the CLI, you can develop, test, and troubleshoot integrations – all without interfering with your production setup. It functions as a free replacement for ngrok and other tunnel solutions when working with webhooks.

For a complete guide to the CLI, including requirements, see the CLI reference.

CLI Reference

CLI Reference for the Hookdeck CLI

Getting started with the CLI

  1. Install the CLI.

  2. Run the hookdeck command in your shell to ensure the CLI is installed.

  3. Optionally, log in using hookdeck login. Otherwise, a temporary guest account is created for you when running commands.

  4. Start a session to forward your webhooks to a local HTTP server using hookdeck listen <port> <source-name?> <connection-query?>, where:

    • <port> defines the localhost port to listen on. Webhooks will be forwarded to http://localhost:$PORT/$DESTINATION_PATH.
    • <source-name> defines a specific source to listen on, if any. By default, the CLI will start listening on all eligible connections for that source.
    • <connection-query> defines which connection to listen for on the specified source. Valid inputs are the name of the connection, or the path of the associated destination.

Events sent to your CLI are available on your CLI Events page, where they can be viewed, filtered, or bookmarked for future use. You can also retry CLI events to replay them locally.