Local Server
Deel recommends using Hookdeck to receive webhooks on your local server. Hookdeck CLI lets you forward webhooks received on any connection to a local web server.
For a complete guide to the Hookdeck CLI, including requirements, see the CLI reference.
Getting started with the CLI
- Install the CLI.
- Run the
hookdeck
command in your shell to ensure the CLI is installed. - Optionally, log in using
hookdeck login
. Otherwise, a temporary guest account is created for you when running commands. - 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.
Updated over 1 year ago