You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/webhooks.rst
+9-8
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ Webhooks
2
2
========
3
3
4
4
The primary method that Read the Docs uses to detect changes to your
5
-
documentation is through the use of *webhooks*. Webhooks are configured with
5
+
documentation and versions is through the use of *webhooks*. Webhooks are configured with
6
6
your repository provider, such as GitHub, Bitbucket or GitLab, and with each commit,
7
7
merge, or other change to your repository, Read the Docs is notified. When we
8
8
receive a webhook notification, we determine if the change is related to an
@@ -41,11 +41,12 @@ GitHub
41
41
42
42
* Go to the **Settings** page for your project
43
43
* Click **Webhooks** and then **Add webhook**
44
-
* For **Payload URL**, use the URL of the integration on Read the Docs, found on
45
-
the the project's **Integrations** Admin dashboard page
44
+
* For **Payload URL**, use the URL of the integration on Read the Docs,
45
+
found on the project's **Integrations** Admin dashboard page
46
46
* For **Content type**, both *application/json* and
47
47
*application/x-www-form-urlencoded* work
48
-
* Select **Just the push event**
48
+
* Select **Let me select individual events**,
49
+
and mark **Pushes**, **Branch or tag creation**, and **Branch or tag deletion** events
49
50
* Finish by clicking **Add webhook**
50
51
51
52
You can verify if the webhook is working at the bottom of the GitHub page under **Recent Deliveries**. If you see a Response 200, then the webhook is correctly configured.
@@ -58,8 +59,8 @@ Bitbucket
58
59
59
60
* Go to the **Settings** page for your project
60
61
* Click **Webhooks** and then **Add webhook**
61
-
* For **URL**, use the URL of the integration on Read the Docs, found on the
62
-
**Dashboard** > **Admin** > **Integrations** page
62
+
* For **URL**, use the URL of the integration on Read the Docs,
63
+
found on the **Dashboard** > **Admin** > **Integrations** page
63
64
* Under **Triggers**, **Repository push** should be selected
64
65
* Finish by clicking **Save**
65
66
@@ -68,8 +69,8 @@ GitLab
68
69
69
70
* Go to the **Settings** page for your project
70
71
* Click **Integrations**
71
-
* For **URL**, use the URL of the integration on Read the Docs, found on the
72
-
**Dashboard** > **Admin** > **Integrations** page
72
+
* For **URL**, use the URL of the integration on Read the Docs,
73
+
found on the **Dashboard** > **Admin** > **Integrations** page
73
74
* Leave the default **Push events** selected and mark **Tag push events** also
0 commit comments