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
+8-4Lines changed: 8 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ To manually set up a webhook, go to :guilabel:`Admin` > :guilabel:`Integrations`
34
34
dashboard page and select the integration type you'd like to add.
35
35
After you have added the integration, you'll see a link to information about the integration.
36
36
37
-
As an example, the URL pattern looks like this: *readthedocs.org/api/v2/webhook/<project-name>/<id>/*.
37
+
As an example, the URL pattern looks like this: *https://readthedocs.org/api/v2/webhook/<project-name>/<id>/*.
38
38
39
39
Use this URL when setting up a new webhook with your provider -- these steps vary depending on the provider:
40
40
@@ -50,15 +50,19 @@ GitHub
50
50
You may need to prepend *https://* to the URL.
51
51
* For **Content type**, both *application/json* and
52
52
*application/x-www-form-urlencoded* work
53
-
* Select **Let me select individual events**,
54
-
and mark **Pushes**, **Branch or tag creation**, and **Branch or tag deletion** events
55
53
* Leave the **Secrets** field blank
56
-
* Finish by clicking **Add webhook**
54
+
* Select **Let me select individual events**,
55
+
and mark **Branch or tag creation**, **Branch or tag deletion** and **Pushes** events
56
+
* Ensure **Active** is enabled; it is by default
57
+
* Finish by clicking **Add webhook**. You may be prompted to enter your GitHub password to confirm your action.
57
58
58
59
You can verify if the webhook is working at the bottom of the GitHub page under **Recent Deliveries**.
59
60
If you see a Response 200, then the webhook is correctly configured.
60
61
For a 403 error, it's likely that the Payload URL is incorrect.
61
62
63
+
GitHub will emit an initial HTTP request (`X-GitHub-Event: ping`) upon creating the webhook and you may notice that the Read the Docs responds with `{"detail":"Unhandled webhook event"}` – this is normal and expected.
64
+
Push changes to your repository and webhooks will work from this point.
65
+
62
66
.. note:: The webhook token, intended for the GitHub **Secret** field, is not yet implemented.
0 commit comments