Skip to content
v2
Feedback

Use the Relay CLI

Tail live events, forward webhooks to localhost and send test messages from your terminal.

You are reading the v2 docs of Relay API. Go to the latest version (v3) →

On this page

Tail live events, forward webhooks to localhost and send test messages from your terminal. Here is exactly what to do.

Steps#

  1. Install the CLI#

    Homebrew: brew install relay/tap/relay.

  2. Sign in#

    relay login opens your browser to confirm.

  3. Forward webhooks#

    relay listen --forward localhost:3000/webhooks.

Tip

The CLI prints the webhook secret to use while forwarding.

Still stuck?#

Include the request ID from the Relay-Request-Id response header — it lets us find your call in seconds.

Was this article helpful?