mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-06-16 05:13:54 -07:00
c6ac9a9f94
# Changelog The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## Changed - Update line length limit from 500 characters to 120 characters. ## Fixed - Most instances of these lint issues: 1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)). 2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)). 3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)). 4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)). Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623 Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org> Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org> Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
84 lines
3.8 KiB
Markdown
84 lines
3.8 KiB
Markdown
---
|
|
eleventyNavigation:
|
|
key: UsingWebhooks
|
|
title: Using Webhooks
|
|
parent: AdvancedUsage
|
|
---
|
|
|
|
Webhooks can help you to automate working with your repository.
|
|
For example it can trigger an defined action if someone pushes to your repository or opens a new issue by using
|
|
a target web URL.
|
|
|
|
Detailed documentation on how to use webhooks can be found in the [forgejo Documentation](https://forgejo.org/docs/latest/user/webhooks/).
|
|
|
|
The following paragraphs will give concrete examples on how to use webhooks with some services.
|
|
|
|
Currently, Codeberg offers implementation templates for the following services:
|
|
|
|
- Forgejo
|
|
- Slack
|
|
- Discord
|
|
- DingTalk
|
|
- Telegram
|
|
- Microsoft Teams
|
|
- Feishu
|
|
- Matrix
|
|
- WeCom
|
|
- Packagist
|
|
|
|
Every service that offers webhook functionality can be added using the **Forgejo** template using the **webhook URL**
|
|
provided by the service.
|
|
|
|
## Using Read the Docs
|
|
|
|
To better illustrate how webhooks can be used, we prepared a tutorial for you that works with \*[Read the Docs](https://readthedocs.io).
|
|
In this example, we will show you how to build your documentation every time that a new commit is pushed to
|
|
your Codeberg repository.
|
|
|
|
<img src="/images/advanced/using-webhooks/using-webhooks-readthedocs-2.jpg" alt="Open the admin settings on ReadTheDocs">
|
|
|
|
1. Login into your _Read the Docs_ account and **select the project** you want to add a webhook to.
|
|
2. Click on the **Admin** button.
|
|
3. In the left side menu, click on **Integrations**.
|
|
|
|
<img src="/images/advanced/using-webhooks/using-webhooks-readthedocs-3.jpg" alt="Open the admin settings on ReadTheDocs">
|
|
|
|
4. Click on the button **Add Integration**.
|
|
5. Select **GitHub incoming webhook**. (GitHub, GitLab or BitBucket incoming webhooks,
|
|
all work equally well and generate the needed webhook URL)
|
|
|
|
<img src="/images/advanced/using-webhooks/using-webhooks-readthedocs-4.jpg" alt="Open the admin settings on ReadTheDocs">
|
|
|
|
6. A **webhook address** will be displayed to you. Write it down and keep it safe!
|
|
|
|
Now go to your Codeberg repository.
|
|
|
|
1. Go to your repository and click on **Settings**.
|
|
2. In the top menu, click on **Webhooks**.
|
|
|
|
<img src="/images/advanced/using-webhooks/using-webhooks-codeberg-1.jpg" alt="Open the admin settings on ReadTheDocs">
|
|
|
|
3. Click on **Add Webhook** and choose **Forgejo**.
|
|
4. Paste the **webhook address** provided by _Read the Docs_ into the **Target URL** field.
|
|
5. You can select when the webhook should be triggered using the **Trigger On** setting.
|
|
For illustrative purposes, we will select **Push Events**; this will trigger the webhook every time that someone
|
|
pushes to your repository.
|
|
|
|
<img src="/images/advanced/using-webhooks/using-webhooks-codeberg.jpg" alt="Open the admin settings on ReadTheDocs">
|
|
|
|
In this example, we do not need to use any other fields to make the webhook work.
|
|
For your personal reference, here are some explanations as to what these other fields do:
|
|
|
|
- **HTTP Method**: Should be "POST" by default, so that the data is sent within the HTTP header
|
|
- **POST Content Type**: specifies how the data should be sent in the header. "application/json"
|
|
and "application/x-www-form-urlencoded" both work with _Read the Docs_
|
|
- **Secret**: For authentication reasons, you can send a secret. For ReadTheDocs leave it empty.
|
|
- **Branch filter**: You can define, that the webhook is only triggered on certain branches in your repository
|
|
- **Authorization Header**: Some services need an authorization to call the webhook
|
|
|
|
Once you're done, you can click on **Add Webhook** to add the webhook to your repository.
|
|
Now, whenever something is pushed to your repository, the webhook will trigger and your _Read the Docs_ documentation
|
|
will be rebuilt.
|
|
|
|
You can confirm that everything is working as it should by selecting the webhook that you just created and clicking on
|
|
the button **Test Delivery**, which will manually trigger your webhook.
|