Skip to content

Latest commit

 

History

History
378 lines (277 loc) · 22.8 KB

building-a-github-app-that-responds-to-webhook-events.md

File metadata and controls

378 lines (277 loc) · 22.8 KB
titleshortTitleintroversionstopicsredirect_fromlayout
Building a GitHub App that responds to webhook events
Respond to webhooks
Learn how to build a {% data variables.product.prodname_github_app %} that makes an API request in response to a webhook event.
fptghesghec
*
*
*
GitHub Apps
/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events
inline

Introduction

This tutorial demonstrates how to write code to create a {% data variables.product.prodname_github_app %} that makes an API request in response to a webhook event. Specifically, when a pull request is opened in a repository that the app was granted access to, the app will receive a pull request webhook event. Then, the app will use {% data variables.product.company_short %}'s API to add a comment to the pull request.

In this tutorial, you will use your computer or codespace as a server while you develop your app. Once the app is ready for production use, you should deploy your app to a dedicated server.

This tutorial uses JavaScript, but you can use any programming language that you can run on your server.

About webhooks

When you register a {% data variables.product.prodname_github_app %}, you can specify a webhook URL and subscribe to webhook events. When activity on {% data variables.product.company_short %} triggers an event that your app is subscribed to, {% data variables.product.company_short %} will send a webhook event to your app's webhook URL.

For example, you can subscribe your {% data variables.product.prodname_github_app %} to the pull request webhook event. When a pull request is opened in a repository that the app was granted access to, {% data variables.product.company_short %} will send a pull request webhook event to your app's webhook URL. If multiple actions can trigger the event, the event payload will include an action field to indicate what type of action triggered the event. In this example, the value of action would be opened since the event was triggered because a pull request was opened.

If your app is running on a server that is listening for these webhook events, then your app can take an action when it receives a webhook event. For example, your app can use the {% data variables.product.company_short %} API to post a comment to the pull request when it receives a pull request webhook event.

For more information, see AUTOTITLE. For information about the possible webhook events and actions, see AUTOTITLE.

Prerequisites

This tutorial requires your computer or codespace to run Node.js version 20 or greater and npm version 6.12.0 or greater. For more information, see Node.js.

This tutorial assumes you have a basic understanding of JavaScript and ES6 syntax.

Setup

The following sections will lead you through setting up the following components:

  • A repository to store the code for your app
  • A way to receive webhooks locally
  • A {% data variables.product.prodname_github_app %} registration that is subscribed to "pull request" webhook events, has permission to add comments to pull requests, and uses a webhook URL that you can receive locally

Create a repository to store code for your app

  1. Create a repository to store the code for your app. For more information, see AUTOTITLE.
  2. Clone your repository from the previous step. For more information, see AUTOTITLE. You may use a local clone or {% data variables.product.prodname_github_codespaces %}.
  3. In a terminal, navigate to the directory where your clone is stored.
  4. If the directory doesn't already include a .gitignore file, add a .gitignore file. You will add content to this file later. For more information about .gitignore files, see AUTOTITLE.

You will add more code to this repository in later steps.

Get a webhook proxy URL

In order to develop your app locally, you can use a webhook proxy URL to forward webhooks from {% data variables.product.company_short %} to your computer or codespace. This tutorial uses Smee.io to provide a webhook proxy URL and forward webhooks.

  1. In your browser, navigate to https://smee.io/.
  2. Click Start a new channel.
  3. Copy the full URL under "Webhook Proxy URL". You will use this URL in a later step.

Register a {% data variables.product.prodname_github_app %}

For this tutorial, you must have a {% data variables.product.prodname_github_app %} registration that:

  • Has webhooks active
  • Uses a webhook URL that you can receive locally
  • Has the "Pull request" repository permission
  • Subscribes to the "Pull request" webhook event

The following steps will guide you through registering a {% data variables.product.prodname_github_app %} with these settings. For more information about {% data variables.product.prodname_github_app %} settings, see AUTOTITLE.

{% data reusables.apps.settings-step %} {% data reusables.apps.enterprise-apps-steps %}

  1. Click New {% data variables.product.prodname_github_app %}.
  2. Under "{% data variables.product.prodname_github_app %} name", enter a name for your app. For example, USERNAME-webhook-test-app where USERNAME is your {% data variables.product.company_short %} username.
  3. Under "Homepage URL", enter a URL for your app. For example, you can use the URL of the repository that you created to store the code for your app.
  4. Skip the "Identifying and authorizing users" and "Post installation" sections for this tutorial. For more information about these settings, see AUTOTITLE.
  5. Make sure that Active is selected under "Webhooks."
  6. Under "Webhook URL", enter your webhook proxy URL from earlier. For more information, see Get a webhook proxy URL.
  7. Under "Webhook secret", enter a random string. You will use this string later.
  8. Under "Repository permissions", next to "Pull requests," select Read & write.
  9. Under "Subscribe to events", select Pull request.
  10. Under "Where can this {% data variables.product.prodname_github_app %} be installed?", select Only on this account. You can change this later if you want to publish your app.{% ifversion enterprise-apps-public-beta %}

    [!NOTE] If your {% data variables.product.prodname_github_app %} is registered under an enterprise, this step does not apply.{% endif %}

  11. Click Create {% data variables.product.prodname_github_app %}.

Write code for your app

The following sections will lead you through writing code to make your app respond to webhook events.

Install dependencies

This tutorial uses {% data variables.product.company_short %}'s octokit module to handle webhook events and make API requests. For more information about Octokit.js, see AUTOTITLE and the Octokit.js README.

This tutorial uses the dotenv module to read information about your app from a .env file. For more information, see dotenv.

This tutorial uses Smee.io to forward webhooks from {% data variables.product.company_short %} to your local server. For more information, see smee-client.

  1. In a terminal, navigate to the directory where your clone is stored.
  2. Run npm init --yes to create a package.json file using the npm defaults.
  3. Run npm install octokit.
  4. Run npm install dotenv.
  5. Run npm install smee-client --save-dev. Since you will only use Smee.io to forward webhooks while you are developing your app, this is a dev dependency.
  6. Add node_modules to your .gitignore file.

Store your app's identifying information and credentials

This tutorial will show you how to store your app's credentials and identifying information as environment variables in a .env file. When you deploy your app, you will want to change how you store the credentials. For more information, see Deploy your app.

Make sure that you are on a secure machine before performing these steps since you will store your credentials locally.

  1. In your terminal, navigate to the directory where your clone is stored.

  2. Create a file called .env at the top level of this directory.

  3. Add .env to your .gitignore file. This will prevent you from accidentally committing your app's credentials.

  4. Add the following contents to your .env file. {% ifversion ghes %}Replace YOUR_HOSTNAME with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %}

    APP_ID="YOUR_APP_ID" WEBHOOK_SECRET="YOUR_WEBHOOK_SECRET" PRIVATE_KEY_PATH="YOUR_PRIVATE_KEY_PATH"{% ifversion ghes %} ENTERPRISE_HOSTNAME="YOUR_HOSTNAME"{% endif %}

  5. {% data reusables.apps.navigate-to-app-settings-page %}

  6. On your app's settings page, next to "App ID", find the app ID for your app.

  7. In your .env file, replace YOUR_APP_ID with the app ID of your app.

  8. On your app's settings page, under "Private keys", click Generate a private key. You will see a private key in PEM format downloaded to your computer. For more information, see AUTOTITLE.

  9. If you are using a codespace, move the downloaded PEM file into your codespace so that your codespace can access the file.

  10. In your .env file, replace YOUR_PRIVATE_KEY_PATH with the full path to your private key, including the .pem extension.

  11. In your .env file, replace YOUR_WEBHOOK_SECRET with the webhook secret for your app. If you have forgotten your webhook secret, under "Webhook secret (optional)", click Change secret. Enter a new secret, then click Save changes.

Add code to respond to webhook events

At the top level of the directory where your clone is stored, create a JavaScript file to hold the code for your app. This tutorial will name the file app.js.

Add the following code to app.js. The code includes annotations that explain each part.

// These are the dependencies for this file.//// You installed the `dotenv` and `octokit` modules earlier. The `@octokit/webhooks` is a dependency of the `octokit` module, so you don't need to install it separately. The `fs` and `http` dependencies are built-in Node.js modules.importdotenvfrom"dotenv";import{App{%ifversionghes%},Octokit{%endif%}}from"octokit";import{createNodeMiddleware}from"@octokit/webhooks";importfsfrom"fs";importhttpfrom"http";// This reads your `.env` file and adds the variables from that file to the `process.env` object in Node.js.dotenv.config();// This assigns the values of your environment variables to local variables.constappId=process.env.APP_ID;constwebhookSecret=process.env.WEBHOOK_SECRET;constprivateKeyPath=process.env.PRIVATE_KEY_PATH;{%ifversionghes%}constenterpriseHostname=process.env.ENTERPRISE_HOSTNAME;{%endif%}// This reads the contents of your private key file.constprivateKey=fs.readFileSync(privateKeyPath,"utf8");// This creates a new instance of the Octokit App class.constapp=newApp({appId: appId,privateKey: privateKey,webhooks: {secret: webhookSecret},{% ifversion ghes%}Octokit: Octokit.defaults({baseUrl: `https://${enterpriseHostname}/api/v3`,}),{% endif %}});// This defines the message that your app will post to pull requests.const messageForNewPRs ="Thanks for opening a new PR! Please follow our contributing guidelines to make your PR easier to review.";// This adds an event handler that your code will call later. When this event handler is called, it will log the event to the console. Then, it will use {% data variables.product.company_short %}'s REST API to add a comment to the pull request that triggered the event.asyncfunctionhandlePullRequestOpened({octokit, payload}){console.log(`Received a pull request event for #${payload.pull_request.number}`);try{awaitoctokit.request("POST /repos/{owner}/{repo}/issues/{issue_number}/comments",{owner: payload.repository.owner.login,repo: payload.repository.name,issue_number: payload.pull_request.number,body: messageForNewPRs,headers: {"x-github-api-version": "{{ allVersions[currentVersion].latestApiVersion }}",},});}catch(error){if(error.response){console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)}console.error(error)}};// This sets up a webhook event listener. When your app receives a webhook event from {% data variables.product.company_short %} with a `X-GitHub-Event` header value of `pull_request` and an `action` payload value of `opened`, it calls the `handlePullRequestOpened` event handler that is defined above.app.webhooks.on("pull_request.opened",handlePullRequestOpened);// This logs any errors that occur.app.webhooks.onError((error)=>{if(error.name==="AggregateError"){console.error(`Error processing request: ${error.event}`);}else{console.error(error);}});// This determines where your server will listen.//// For local development, your server will listen to port 3000 on `localhost`. When you deploy your app, you will change these values. For more information, see [Deploy your app](#deploy-your-app).constport=3000;consthost= 'localhost';constpath= "/api/webhook";constlocalWebhookUrl= `http://${host}:${port}${path}`;// This sets up a middleware function to handle incoming webhook events.//// Octokit's `createNodeMiddleware` function takes care of generating this middleware function for you. The resulting middleware function will://// - Check the signature of the incoming webhook event to make sure that it matches your webhook secret. This verifies that the incoming webhook event is a valid {% data variables.product.company_short %} event.// - Parse the webhook event payload and identify the type of event.// - Trigger the corresponding webhook event handler.constmiddleware=createNodeMiddleware(app.webhooks,{path});// This creates a Node.js server that listens for incoming HTTP requests (including webhook payloads from {% data variables.product.company_short %}) on the specified port. When the server receives a request, it executes the `middleware` function that you defined earlier. Once the server is running, it logs messages to the console to indicate that it is listening.http.createServer(middleware).listen(port,()=>{console.log(`Server is listening for events at: ${localWebhookUrl}`);console.log('Press Ctrl + C to quit.')});

Add a script to run the code for your app

  1. To the scripts object in your package.json file, add a script called server that runs node app.js. For example:

    "scripts": { "server": "node app.js" }

    If you called the file that holds your app's code something other than app.js, replace app.js with the relative path to the file that holds your app's code.

  2. In your package.json file, add a top level key type with the value module. For example:

     { // rest of the JSON object,"version": "1.0.0", "description": "", "type": "module", // rest of the JSON object, }

Your package.json file should look something like this. The name value and the version numbers under dependencies and devDependencies may differ for you.

 { "name": "github-app-webhook-tutorial", "version": "1.0.0", "description": "", "main": "index.js", "type": "module", "scripts": { "server": "node app.js" }, "keywords": [], "author": "", "license": "ISC", "dependencies": { "dotenv": "^16.0.3", "octokit": "^2.0.14" }, "devDependencies": { "smee-client": "^1.2.3" } }

Testing

Follow these steps to test the app that you created above.

Install your app

In order for your app to leave a comment on pull requests in a repository, it must be installed on the account that owns the repository and granted access to that repository. Since your app is private, it can only be installed on the account that owns the app.

  1. In the account that owns the app you created, create a new repository to install the app on. For more information, see AUTOTITLE.
  2. {% data reusables.apps.navigate-to-app-settings-page %}
  3. Click Public page.
  4. Click Install.
  5. Select Only select repositories.
  6. Select the Select repositories dropdown menu and click the repository that you chose at the start of this section.
  7. Click Install.

Start your server

For testing, you will use your computer or codespace as a server. Your app will only respond to webhooks when your server is running.

  1. In a terminal, navigate to the directory where your app's code is stored.

  2. To receive forwarded webhooks from Smee.io, run npx smee -u WEBHOOK_PROXY_URL -t http://localhost:3000/api/webhook. Replace WEBHOOK_PROXY_URL with your webhook proxy URL from earlier. If you forgot your URL, you can find it in the "webhook URL" field on your app's settings page.

    You should see output that looks like this, where WEBHOOK_PROXY_URL is your webhook proxy URL:

    Forwarding WEBHOOK_PROXY_URL to http://localhost:3000/api/webhook Connected WEBHOOK_PROXY_URL

  3. In a second terminal window, navigate to the directory where your app's code is stored.

  4. Run npm run server. Your terminal should say, Server is listening for events at: http://localhost:3000/api/webhook.

Test your app

Now that your server is running and receiving forwarded webhooks events, test your app by opening a pull request on the repository that you selected when you installed your app.

  1. Open a pull request on the repository that you selected when you installed your app. For more information, see AUTOTITLE.

    Make sure to use the repository that you selected when you installed your app, not the repository where your app's code is stored. For more information, see Install your app.

  2. Navigate to your webhook proxy URL on smee.io. You should see a pull_request event. This indicates that {% data variables.product.company_short %} successfully sent a pull request event when you created a pull request.

  3. In the terminal where you ran npm run server, you should see something like "Received a pull request event for #1" where the integer after the # is the number of the pull request that you opened.

  4. In the timeline of your pull request, you should see a comment from your app.

  5. In both terminal windows, enter Ctrl+C to stop your server and stop listening for forwarded webhooks.

Next steps

Now that you have an app that responds to webhook events, you might want to expand your app's code, deploy your app, and make your app public.

Modify the app code

This tutorial demonstrated how to post a comment on a pull request in when a pull request was opened. You can update the code to respond to different types of webhook events or to do something different in response to the webhook event.

Remember to update your app's permissions if your app needs additional permissions for the API requests that you want to make or the webhook events you want to receive. For more information, see AUTOTITLE.

This tutorial stored all of the code into a single file, but you may want to move functions and components into separate files.

Deploy your app

This tutorial demonstrated how to develop your app locally. When you are ready to deploy your app, you need to make changes to serve your app and keep your app's credential secure. The steps you take depend on the server that you use, but the following sections offer general guidance.

Host your app on a server

This tutorial used your computer or codespace as a server. Once the app is ready for production use, you should deploy your app to a dedicated server. For example, you can use Azure App Service.

Update the webhook URL

Once you have a server that is set up to receive webhook traffic from {% data variables.product.company_short %}, update the webhook URL in your app settings. You should not use Smee.io to forward your webhooks in production.

Update the port and host constants

When you deploy your app, you will want to change the host and port where your server is listening.

For example, you can set a PORT environment variable on your server to indicate the port where your server should listen. You can set a NODE_ENV environment variable on your server to production. Then, you can update the place where your code defines the port and host constants so that your server listens to all available network interfaces (0.0.0.0) instead of the local network interface (localhost) on your deployment port:

constport=process.env.PORT||3000;consthost=process.env.NODE_ENV==='production' ? '0.0.0.0' : 'localhost';

Secure your app's credentials

You should never publicize your app's private key or webhook secret. This tutorial stored your app's credentials in a gitignored .env file. When you deploy your app, you should choose a secure way to store the credentials and update your code to get the value accordingly. For example, you can store the credentials with a secret management service like Azure Key Vault. When your app runs, it can retrieve the credentials and store them in environment variables on the server where your app is deployed.

For more information, see AUTOTITLE.

Share your app

If you want to share your app with other users and organizations, make your app public. For more information, see AUTOTITLE.

Follow best practices

You should aim to follow best practices with your {% data variables.product.prodname_github_app %}. For more information, see AUTOTITLE.

close