Skip to content

Commit 68ceee9

Browse files
authored
Merge pull request #5040 from stsewd/update-webhook-docs
Update webhook docs
2 parents f7926c4 + a6b991c commit 68ceee9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/webhooks.rst

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Webhooks
22
========
33

44
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
66
your repository provider, such as GitHub, Bitbucket or GitLab, and with each commit,
77
merge, or other change to your repository, Read the Docs is notified. When we
88
receive a webhook notification, we determine if the change is related to an
@@ -41,11 +41,12 @@ GitHub
4141

4242
* Go to the **Settings** page for your project
4343
* 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
4646
* For **Content type**, both *application/json* and
4747
*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
4950
* Finish by clicking **Add webhook**
5051

5152
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
5859

5960
* Go to the **Settings** page for your project
6061
* 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
6364
* Under **Triggers**, **Repository push** should be selected
6465
* Finish by clicking **Save**
6566

@@ -68,8 +69,8 @@ GitLab
6869

6970
* Go to the **Settings** page for your project
7071
* 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
7374
* Leave the default **Push events** selected and mark **Tag push events** also
7475
* Finish by clicking **Add Webhook**
7576

0 commit comments

Comments
 (0)