Quick Start Guide

This guide will help you get started with HookFlow in just a few minutes. You'll learn how to create your first webhook source, configure a destination, and start receiving webhooks.

Step 1: Create an Account

If you haven't already, sign up for a HookFlow account by visiting our login page and clicking "Sign Up".

Step 2: Create Your First Webhook Source

After logging in, you'll be directed to your dashboard. To create your first webhook source:

  1. Click the "Create New Source" button in the dashboard or navigate to Sources and click "Add Source".
  2. Fill in the source details:
    • Name: A descriptive name for your webhook source (e.g., "Stripe Payments")
    • Provider Template: (Optional) Select a pre-configured template if you're using a common service like Stripe or GitHub
    • Description: (Optional) Add details about this source
  3. If your webhook provider uses signature verification, enter your Secret Key and configure the signature settings.

Note: For security, we recommend always using signature verification when available.

Step 3: Configure a Destination

Next, you'll need to configure at least one destination where your webhooks will be forwarded:

  1. In the Destinations section, enter:
    • Name: A name for this destination (e.g., "My API")
    • Target URL: The URL where webhooks should be forwarded (e.g., "https://myapp.com/api/webhooks")
    • Description: (Optional) Additional details about this destination
  2. Configure retry settings:
    • Strategy: Choose between exponential or fixed interval retries
    • Interval: Set the time between retry attempts
    • Max Attempts: Define how many times HookFlow should retry failed deliveries
  3. Click "Create Source" to save your configuration.

Step 4: Get Your Webhook URL

After creating your source, you'll receive a unique webhook URL in the format:

https://hookflow.com/hook/[userId]/[hookId]

Copy this URL and paste it into your webhook provider's settings (e.g., Stripe Dashboard, GitHub repository settings).

Step 5: Test Your Webhook

To verify everything is working correctly:

  1. Trigger a test webhook from your provider (most services have a way to send test webhooks).
  2. Return to your HookFlow dashboard and watch for the incoming webhook.
  3. Click on the webhook to view details and verify it was delivered to your destination.

Next Steps

Now that you have your first webhook source set up, you can explore more advanced features:

Need Help?

If you encounter any issues during setup, our support team is here to help.