Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.18 KB

README.md

File metadata and controls

59 lines (35 loc) · 2.18 KB

Front Application Webhook Template

A Front Application Webhook processing application template optimized for deployment on Railway.app.

This template provides a robust foundation for handling events received from an Application Webhook with payload validation, integrity checking and built-in queue processing to allow you to process events asynchronously at scale.

Features

  • 🔒 Built-in webhook signature validation
  • 📝 Schema-based payload validation
  • 🔄 Queue-based webhook processing by BullMQ
  • 🚦 Challenge-response handling
  • 🚀 Ready to deploy on Railway.app

Quick Start

Deploy on Railway

  1. Click the "Deploy on Railway" button to deploy the template to Railway.

  2. Once deployed, Railway will automatically set up your environment.

  3. Ensure you set your FRONT_APP_SECRET environment variable in Railway.

  4. Once deployed, click in to the Front Application Webhook GitHub resource -> Settings tab -> Networking, then copy the Public Networking URL for use in your Front Application Webhook settings.

For local development:

Copy the .env.example file to .env and set your FRONT_APP_SECRET environment variable, and your Redis credentials.

# Install dependencies
npm install

# Start the development server
npm run dev

# The server will start at http://localhost:3000

Environment Variables

On deploying this template, Railway will automatically set the Redis environment variables for you. You will need to set the FRONT_APP_SECRET environment variable in Railway.

API Endpoints

  • POST /ingest: Main Application Webhook endpoint

Development

To modify this template for your use case, the first step is to update the queue processing logic in src/queue/worker.ts. This is where you'll add your logic for processing how you want to handle the received events.

Contributing

Contributions are welcome and encouraged! Please feel free to submit a Pull Request.

License

MIT License