README.md

Github Webhook

Serverless component that provisions github webhooks

• Input Types
• Output Types
• Example
• Github Webhook Event Types

Input Types

Name	Type	Description
githubApiToken	string required	GitHub personal access token needed for access to the github API. Create a token
githubRepo	string required	The GitHub repos URL
payloadUrl	string required	Payload Url
events	array required	What type of event(s) will trigger the webhook URL. List of allowed events. For more details on events & payloads see the docs

Output Types

Name	Type	Description
github	object	The GitHub Webhook configuration

Example

type: my-application
components:
  myGithubWebhook:
    type: github-webhook
    inputs:
      githubApiToken: 2c5acc7de3b140ser3114fd40a24vd5ie3d843b5
      githubRepo: 'https://github.com/serverless/components/'
      payloadUrl: 'https://your-webhook-url-to-trigger-from-repo.com/'
      events:
        - create

Github Webhook Event Types

List of allowed events. For more details on events & payloads see the docs

• *
• commit_comment
• create
• delete
• deployment
• deployment_status
• fork
• gollum
• installation
• installation_repositories
• issue_comment
• issues
• label
• marketplace_purchase
• member
• membership
• milestone
• organization
• org_block
• page_build
• project_card
• project_column
• project
• public
• pull_request_review_comment
• pull_request_review
• pull_request
• push
• repository
• release
• status
• team
• team_add
• watch