Destination type

CLI Destination Configuration

Use CLI destinations to forward provider traffic, test events, and replayed events to a service running on your machine through fasthook-cli. This destination configuration reference covers the fields and delivery behavior required to connect it to FastHook.

FastHook delivers through the authenticated CLI tunnel.

CLIAuthenticated fasthook-cli tunnelPOST, PUT, PATCH, DELETELocal development
All destination typesDestinations docs
CLI destination delivery flowFastHook routes accepted events through a connection to a CLI destination and stores delivery attempt evidence.AcceptedRequestsource verifiedConnectionRoute branchfilters and transformsretry policyCLICLIAuthenticated fasthook-cli tunnelPOST, PUT, PATCH, DELETEAttemptEvidencestatus + bodyDestination config owns target, auth, method, rate limit, disabled state, and delivery attempt evidence.

CLI dashboard fields

CLI path

Optional local path such as /webhooks/orders. Defaults to /.

HTTP method

Method used when the CLI forwards the delivery to localhost.

Max delivery rate

Optional pacing for local delivery during debugging or replay.

CLI API config

config.path

Optional path appended to the local URL supplied by the active CLI tunnel.

config.http_method

Method FastHook asks the CLI tunnel to use for local delivery.

config.rate_limit

Optional pacing limit for local tunnel deliveries.

config.rate_limit_period

Rate-limit period: second, minute, or hour.

CLI destination config
{
  "name": "local-orders-api",
  "type": "CLI",
  "config": {
    "path": "/webhooks/orders",
    "http_method": "POST",
    "rate_limit": 10,
    "rate_limit_period": "second"
  }
}

CLI authentication

  • Authenticated FastHook CLI tunnel session

CLI delivery method and limit

POSTPUTPATCHDELETE

Rate limit: Optional. Useful when replaying many events into a local service.

CLI delivery behavior

  • A CLI destination does not store localhost host or port. The active CLI command supplies the local target with --to.
  • FastHook delivers the event to the tunnel service, and the authenticated CLI session forwards it to the local receiver.
  • The CLI sends local response status, headers, body, and errors back so FastHook can store attempt evidence.
  • More than one CLI can connect to the same destination, but separate destinations are easier to reason about for separate developers.

CLI setup checklist

  1. Create a destination and choose CLI as the destination type.
  2. Optionally set a CLI path. Leave it blank to use /.
  3. Create or edit a connection so accepted source events route to the CLI destination.
  4. Log in with fasthook-cli and start a tunnel with fasthook tunnel --destination des_xxx --to 8080.
  5. Send or replay events and inspect the local receiver response in FastHook attempts.

CLI troubleshooting

No delivery reaches localhost.

Start fasthook tunnel with the correct destination id and confirm the local --to URL is listening.

HTTP 502 Local Fetch Failed.

The CLI was connected, but the local receiver did not answer successfully. Check host, port, path, and local logs.

Events go to the wrong local route.

Check the destination path and the --to value. The path is stored on the destination; host and port come from the CLI session.

Related docs