Skip to content

Latest commit

 

History

History
112 lines (69 loc) · 5.01 KB

functions-create-github-webhook-triggered-function.md

File metadata and controls

112 lines (69 loc) · 5.01 KB
title description services documentationcenter author manager editor tags ms.assetid ms.service ms.devlang ms.topic ms.tgt_pltfrm ms.workload ms.date ms.author ms.custom
Create a function in Azure triggered by a GitHub webhook | Microsoft Docs
Use Azure Functions to create a serverless function that is invoked by a GitHub webhook.
functions
na
ggailey777
cfowler
36ef34b8-3729-4940-86d2-cb8e176fcc06
functions
multiple
quickstart
multiple
na
03/28/2018
glenga
mvc, cc996988-fb4f-47

Create a function triggered by a GitHub webhook

Learn how to create a function that is triggered by an HTTP webhook request with a GitHub-specific payload.

Github Webhook triggered function in the Azure portal

Prerequisites

  • A GitHub account with at least one project.
  • An Azure subscription. If you don't have one, create a free account before you begin.

Create an Azure Function app

[!INCLUDE Create function app Azure portal]

Function app successfully created.

Next, you create a function in the new function app.

Create a GitHub webhook triggered function

  1. Expand your function app and click the + button next to Functions. If this is the first function in your function app, select Custom function. This displays the complete set of function templates.

    Functions quickstart page in the Azure portal

  2. In the search field, type github and then choose your desired language for the GitHub webhook trigger template.

    Choose the GitHub webhook trigger template

  3. Type a Name for your function, then select Create.

    Configure the GitHub webhook triggered function in the Azure portal

  4. In your new function, click </> Get function URL, then copy and save the values. Do the same thing for </> Get GitHub secret. You use these values to configure the webhook in GitHub.

    Review the function code

Next, you create a webhook in your GitHub repository.

Configure the webhook

  1. In GitHub, navigate to a repository that you own. You can also use any repository that you have forked. If you need to fork a repository, use https://github.com/Azure-Samples/functions-quickstart.

  2. Choose Settings > Options and make sure that Issues is enabled under Features.

    Enable Issues

  3. In Settings, choose Webhooks > Add webhook.

    Add a GitHub webhook

  4. Use settings as specified in the following table, then click Add webhook:

    Set the webhook URL and secret

Setting Suggested value Description
Payload URL Copied value Use the value returned by </> Get function URL.
Content type application/json The function expects a JSON payload.
Secret Copied value Use the value returned by </> Get GitHub secret.
Event triggers Let me select individual events We only want to trigger on issue comment events.
Issue comment

Now, the webhook is configured to trigger your function when a new issue comment is added.

Test the function

  1. In your GitHub repository, open the Issues tab in a new browser window.

  2. In the new window, click New Issue, type a title, and then click Submit new issue.

  3. In the issue, type a comment and click Comment.

    Add a GitHub issue comment.

  4. Go back to the portal and view the logs. You should see a trace entry with the new comment text.

    View the comment text in the logs.

Clean up resources

[!INCLUDE Next steps note]

Next steps

You have created a function that is triggered when a request is received from a GitHub webhook.

[!INCLUDE Next steps note]

For more information about webhook triggers, see Azure Functions HTTP and webhook bindings.