Quick Start Guide

Get up and running with Webhook Simulator in just a few minutes. This guide will walk you through the basic steps to start simulating webhook events and testing your integrations.

Prerequisites

Before you begin, ensure you have the following:

• A modern web browser (Chrome, Firefox, Safari, or Edge)
• An active internet connection
• Homebrew installed on your machine (for CLI installation)

Step 1: Sign Up or Log In

1. Visit the Webhook Simulator website.
2. Click on the "Sign Up" button if you're a new user, or "Log In" if you already have an account.
3. Follow the prompts to create your account or log in.

Step 2: Explore Available Platforms

1. After logging in, navigate to the "Platforms" menu.
2. Browse through the list of available platforms (e.g., Stripe, Chargebee, Coinbase, Zendesk).
3. Add desired platforms to your library by clicking on them.

Step 3: Access Live Logs

1. Go to your library page.
2. Select a platform you've added.
3. Click the "View Live Logs" button to access the live stream page.

Step 4: Set Up Webhook URL

On the live stream page, you'll find a unique webhook URL for the selected platform. You have two options:

a) To receive real events:

• Copy this URL and paste it into the webhook settings of your actual platform account.

b) To simulate events:

• Use the pre-generated payloads available on the live logs page to simulate events.

Note: You can use both real and simulated events simultaneously for comprehensive testing.

Step 5: Install and Configure the CLI Tool

To forward webhooks to your local development environment, you need to set up the CLI tool:

1. Install the CLI:

brew tap mmpsoftware/ws-cli
brew install ws-cli

2. Authenticate:

ws-cli login

3. Start redirecting webhooks:

ws-cli listen --forward-to [yourLocalAppUrl]

Step 6: Simulate or Receive Webhooks

• To simulate events from the web app, use the pre-generated payloads on the live logs page.
• To simulate events using CLI:

ws-cli trigger [provider-name] [event-name]

For example:

ws-cli trigger Stripe customer.created

• To receive real events, ensure you've set up the webhook URL in your platform account (Step 4a).

Step 7: Monitor and Analyze

• Watch the CLI output to see incoming payloads and responses from your app.
• Check the live logs page on the web app for real-time updates.
• Use the "Logs" menu to access historical data with advanced search capabilities.

Next Steps

Congratulations! You've set up Webhook Simulator and are ready to start testing your integrations. Here are some next steps to explore:

• Dashboard Overview: Learn more about the web application interface.
• CLI Advanced Usage: Discover advanced features of the CLI tool.
• Webhook Security: Understand best practices for secure webhook handling.
• Custom Integrations: Learn how to set up custom webhook providers.