Skip to content

algolia/github-helpscout-collector

Repository files navigation

GitHub HelpScout Collector

This is a server to collect issues events from GitHub through webhooks and sent them to HelpScout with the Mailbox API 2.0. To link repositories to mailboxes we use the environment variable HELP_SCOUT_MAILBOXES. The stucture of the JSON looks like this:

{
  "data": [
    {
      "label": "<teamName>",
      "mailboxId": "<mailboxId>",
      "assignTo": "<assignTo>",
      "repositories": [
        "<repoId>",
        "<repoId>",
      ]
    },
    {
      "label": "<teamName>",
      "mailboxId": "<mailboxId>",
      "repositories": [
        "<repoId>",
        "<repoId>",
      ]
    }
  ]
}

Run the production server

GITHUB_WEBHOOK_SECRET=yourGitHubWebTokenSecret \
HELP_SCOUT_APP_ID=yourHelpScoutAppId \
HELP_SCOUT_APP_SECRET=yourHelpScoutAppSecrect \
HELP_SCOUT_MAILBOXES={...} \
yarn start

Run the devlopment server

GITHUB_WEBHOOK_SECRET=yourGitHubWebTokenSecret \
HELP_SCOUT_APP_ID=yourHelpScoutAppId \
HELP_SCOUT_APP_SECRET=yourHelpScoutAppSecrect \
HELP_SCOUT_MAILBOXES={...} \
yarn dev

Run the build

yarn build

Run the test

yarn test

About

Push GitHub issues to HelpScout

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •