Skip to content

SETUP_GUIDE.md

Latest commit

 

History

History
123 lines (84 loc) · 2.97 KB

SETUP_GUIDE.md

File metadata and controls

123 lines (84 loc) · 2.97 KB

Complete Setup Guide

This guide walks you through setting up Volley for local webhook development from scratch.

Step 1: Create Volley Account

  1. Go to volleyhooks.com
  2. Click "Get Started" or "Sign Up"
  3. Create your free account (10K events/month free)

Step 2: Install Volley CLI

macOS

brew tap volleyhq/volley
brew install volley

Linux

# For amd64
wget https://github.com/volleyhq/volley-cli/releases/latest/download/volley-linux-amd64.tar.gz
tar -xzf volley-linux-amd64.tar.gz
sudo mv volley /usr/local/bin/

# For arm64
wget https://github.com/volleyhq/volley-cli/releases/latest/download/volley-linux-arm64.tar.gz
tar -xzf volley-linux-arm64.tar.gz
sudo mv volley /usr/local/bin/

Windows

Download from GitHub Releases and extract.

Step 3: Login to Volley

volley login

Enter your email and password when prompted.

Step 4: Create Webhook Source

  1. Go to Volley Dashboard
  2. Create a new organization (if you don't have one)
  3. Create a new project (if you don't have one)
  4. Click "Create Source"
  5. Give it a name (e.g., "stripe-webhooks", "github-events")
  6. Copy your ingestion ID (e.g., abc123xyz)

Your webhook URL will be: https://api.volleyhooks.com/hook/YOUR_INGESTION_ID

Step 5: Configure Your Webhook Provider

Stripe

  1. Go to Stripe Dashboard
  2. Click "Add endpoint"
  3. Enter: https://api.volleyhooks.com/hook/YOUR_INGESTION_ID
  4. Select events to listen to
  5. Click "Add endpoint"

GitHub

  1. Go to your repository → Settings → Webhooks
  2. Click "Add webhook"
  3. Enter: https://api.volleyhooks.com/hook/YOUR_INGESTION_ID
  4. Select events
  5. Click "Add webhook"

Twilio

  1. Go to Twilio Console
  2. Navigate to your phone number
  3. Set webhook URL: https://api.volleyhooks.com/hook/YOUR_INGESTION_ID

Step 6: Start Your Local Server

See examples in the main README for your preferred language/framework.

Step 7: Forward Webhooks

volley listen --source YOUR_INGESTION_ID --forward-to http://localhost:3000/webhook

Replace:

  • YOUR_INGESTION_ID with your actual ingestion ID
  • http://localhost:3000/webhook with your local endpoint

Step 8: Test It!

  1. Trigger a webhook from your provider
  2. Watch it appear in your local server logs
  3. Check Volley dashboard for delivery status

Troubleshooting

Webhooks not arriving?

  1. Check that Volley CLI is running
  2. Verify your ingestion ID is correct
  3. Check that your local server is running
  4. Verify the forward-to URL is correct
  5. Check Volley dashboard for delivery attempts

Authentication issues?

volley logout
volley login

Need help?