Skip to content

Commit e4d0c80

Browse files
zxiiroberkerpeksag
authored andcommitted
Add mention of version_slug parameter when using webhook (#2599)
Signed-off-by: Thanh Ha <[email protected]> Fixes #2138
1 parent c8dd189 commit e4d0c80

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/webhooks.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ look something along the lines of ``http://readthedocs.org/build/<project_name>`
4848
Regardless of which revision control system you use, you can just hit this URL
4949
to kick off a rebuild.
5050

51+
The following parameters available to customize the behavior of custom webhooks:
52+
53+
* ``'version_slug'``: The build version to trigger build for (defaults to ``'latest'``)
54+
55+
Example::
56+
57+
$ curl -X POST --data "version_slug=$VERSION" https://readthedocs.org/build/$PROJECT_NAME
58+
5159
You could make this part of a hook using Git_, Subversion_, Mercurial_, or
5260
Bazaar_, perhaps through a simple script that accesses the build URL using
5361
``wget`` or ``curl``.

0 commit comments

Comments
 (0)