How We Converted a GitHub Tool Into a General Purpose Webhook Proxy to Supercharge Our Integration Development

• smee-client

  4 384 7.8 TypeScript

  🔴 Receives payloads then sends them to your local server

  

Webhooks automate workflows by sending data from one app to another on certain events. They require a public URL, which can be a problem for testing or development. Smee.io is a payload delivery service which proxies payloads from the webhook source and transmit them to a locally running app. However, it was designed for GitHub, so customizing it for other services is necessary - here's how we did it.

• probot

  11 8,717 7.7 TypeScript

  🤖 A framework for building GitHub Apps to automate and improve your workflow

  

Since smee.io was designed to work with Probot for enabling development of GitHub applications it works very well with GitHub webhooks and its UI is somewhat tailored for use with GitHub (parsing GitHub specific headers); however, if you want to leverage smee.io for other services that use webhooks you may hit a few snags.

• SurveyJS

  surveyjs.io sponsored

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• frp

  111 79,379 9.0 Go

  A fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.

Tunneling services can be considered as a solution in some cases. Services like ngrok, frp, localtunnel and sish create a public endpoint that tunnels communication to your local endpoint via a tunnel client.

• ngrok

  100 2,292 3.1 JavaScript

  Expose your localhost to the web. Node wrapper for ngrok. (by bubenshchykov)

Tunneling services can be considered as a solution in some cases. Services like ngrok, frp, localtunnel and sish create a public endpoint that tunnels communication to your local endpoint via a tunnel client.

• sish

  32 3,763 6.3 Go

  HTTP(S)/WS(S)/TCP Tunnels to localhost using only SSH.

Tunneling services can be considered as a solution in some cases. Services like ngrok, frp, localtunnel and sish create a public endpoint that tunnels communication to your local endpoint via a tunnel client.

• GitGoat

  9 162 0.0 Python

  GitGoat is an open source tool that was built to enable DevOps and Engineering teams to design and implement a sustainable misconfiguration prevention strategy. It can be used to test products with access to GitHub repositories without a risk to your production environment.

  

Doron Guttman and Roei Ben-Harush @ [arnica], April 2023

• smee.io

  1 305 0.0 JavaScript

  ☁️📦 Webhook payload delivery service

  

My recommended starting point is to fork/clone the smee.io repo and get it working. And by working, I don't mean deploying it, but being able to build and run it locally to a point where you can place a break point in the code and have it pause there. This is necessary in order to customize any code. I actually had some issues doing that with the main branch as it was in commit 3a01759.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• smee.io

  1 0 0.0

  ☁️📦 Webhook payload delivery service (by arnica-ext)

  

You can find the final package.json and Dockerfile here.

• node-config

  20 6,195 5.7 JavaScript

  Node.js Application Configuration

  

This will allow to set a security operation mode and configure the channels. I chose to use the config package as I had good experience with it and it supports cascading config options.

Suggest a related project