/webHooks

Primary LanguageGo

webHooks

This simple GoLang application provides a local testing environment for services utilizing webhooks. It allows users to test webhook functionality without the need for external public services. Particularly useful when working with sensitive data, this server ensures that testing is secure and private.

Features:

  • Local Testing Environment: Run the server locally to simulate webhook events within a controlled environment.
  • Secure Testing with Sensitive Data: Keep your sensitive data secure by avoiding the use of external public services for webhook testing.

Getting Started:

Prerequisites:

  • GoLang installed on your machine.

Installation:

  1. Clone the repository:

    git clone https://github.com/rkiwi/webHooks.git
    cd webHooks
  2. Build the executable:

    go build webHooks.go

Usage:

  1. Run the server (with flags if you want to customise output):

    ./webHooks

    The server provides several options that can be configured through command-line flags:

    -answer (bool)

    Enable/disable answer from service (Status: OK, Data received) (default true)
    
    image

    -headers (bool)

    Enable/disable technical information of request (default true)
    
    image

    -port (int)

    Set listening port of webhook catcher (default 8080)
    

    -pretty (bool)

    Enable/disable pretty JSON formatting (default true)
    
    image
  2. Sending Requests:

    Send your webhook requests to:

    https://localhost:<your_port>
    

    Example:

    curl -X POST http://127.0.0.1:8080 \                                                                                                                                                                                        ─╯
    -d '{"key": "value"}'
  3. Tracking Requests:

    Observe incoming webhook requests directly in the terminal where the server is running.