Skip to content

Webhooks

Jannik Huschka edited this page Aug 3, 2022 · 1 revision

We have implemented real-time updates via GitHub Webhooks and a ruby script served by fly.io (which is free).
In order to use them in the future, do the following:

  • Get information about your project board and write down the project ID.
  • Using the files config.ru, fly.toml, Gemfile, Gemfile.lock, hook.rb in the scripts folder, set up the fly script.
    • See the fly.io docs for more information
    • If you don't like Ruby, feel free to write a script in another language.
  • Go to the repo settings under Webhooks and set up a new webhook.
    • As Payload URL, use https://your-fly-project-name.fly.dev/projectID/payload
      • While writing this, I recognize that it is stupid to use a project ID in the repo webhook settings. In the future, this should be changed to use a repo ID.
    • Select every event relevant to project board changes (Issues, Projects, Project columns, Project cards)
  • Change the method SPBGithubAPI>>getWebhookChanges: to also use your fly script URL.

Now you should be good to go and Squello should update automatically!

Clone this wiki locally