Terraform module to provision webhooks on a set of GitHub repositories. This is useful if you need to register a webhook en masse across dozens of repositories.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
Create a GitHub Personal Access Token that has admin:repo_hook
for full control of repository hooks; in otherwords, we need write:repo_hook
to write repository hooks and read:repo_hook
to read repository hooks.
module "github_webhooks" {
source = "git::https://github.com/cloudposse/terraform-github-repository-webhooks.git?ref=master"
github_organization = "cloudposse"
github_token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
github_repositories = "geodesic"
webhook_url = "https://atlantis.prod.company.com/"
content_type = "application/json"
events = ["issues"]
}
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Description | Type | Default | Required |
---|---|---|---|---|
active | Indicate of the webhook should receive events. | string | true |
no |
enabled | Whether or not to enable this module | string | true |
no |
events | A list of events which should trigger the webhook. | list | <list> |
no |
github_organization | GitHub organization to use when creating webhook | string | - | yes |
github_repositories | List of repository names which should be associated with the webhook | list | <list> |
no |
github_token | GitHub token used for API access | string | - | yes |
name | The type of webhook | string | web |
no |
webhook_content_type | Webhook Content Type (E.g. application/json) | string | application/json |
no |
webhook_insecure_ssl | Webhook Insecure SSL (E.g. trust self-signed certificates) | string | false |
no |
webhook_secret | Webhook secret | string | `` | no |
webhook_url | Webhook URL | string | - | yes |
Check out these related projects.
- terraform-aws-cicd - Terraform Module for CI/CD with AWS Code Pipeline and Code Build
- terraform-aws-codebuild - Terraform Module to easily leverage AWS CodeBuild for Continuous Integration
For additional context, refer to some of these links.
- GitHub Event Types - The list of supported event types which can trigger a webhook
- GitHub Hook Types - The type of the webhooks.
Got a question?
File a GitHub issue, send us an email or join our Slack Community.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
- Questions. We'll use a Shared Slack channel between your team and ours.
- Troubleshooting. We'll help you triage why things aren't working.
- Code Reviews. We'll review your Pull Requests and provide constructive feedback.
- Bug Fixes. We'll rapidly work to fix any bugs in our projects.
- Build New Terraform Modules. We'll develop original modules to provision infrastructure.
- Cloud Architecture. We'll assist with your cloud strategy and design.
- Implementation. We'll provide hands-on support to implement our reference architectures.
Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2018 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com
We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!
We offer paid support on all of our projects.
Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.
![]() Erik Osterman |
![]() Igor Rodionov |
![]() Andriy Knysh |
---|