Inbound webhooks as code
2 minute read
Once an inbound webhook is linked to a repository, you can push it, preview the changes, and later refresh the webhook from the repository. You can also create a webhook from one already in a repository. This requires a repository linked to Cloud Management Platform (CMP) and repository credentials on your profile so commits are attributed to you. See Integrate a remote source code repository.
Push and refresh an inbound webhook
Open the webhook from Admin > Inbound Web Hooks, then select its repository tab. The tab is named Repository until the webhook is linked to a repository; then it is named GitHub or GitLab.
Push to Remote Source opens a form for a Repository, Branch, and Commit Message. If the webhook has been pushed before, select Preview first to see what changed. After the push, the result includes a link to open a pull request.
Refresh from Remote Source prompts for a Repository and Branch, then updates the webhook in CMP based on the repository’s contents. It appears once the webhook has been pushed or created from a repository, and the tab also shows the repository, the remote source URL, and when the webhook was last refreshed.
A webhook that came from a repository is read-only unless Remote Content Mode in Miscellaneous Settings allows editing. While it is read-only, Push to Remote Source is disabled.
Create an inbound webhook from a repository
- Go to Admin > Inbound Web Hooks.
- Select Create from Repository.
- Provide a Repository, Branch, and Inbound Web Hook JSON File.
- Optionally select Ignore Action Enable to create the webhook disabled and ignore later changes to its enabled state.
- Select Save.
Related
- Integrate a remote source code repository: Linking a repository and setting credentials for your commits.
- Inbound webhooks: Writing the endpoint and the code behind it.