forked from bloomberg/python-github-webhook
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_reference.html
More file actions
139 lines (127 loc) · 5.89 KB
/
api_reference.html
File metadata and controls
139 lines (127 loc) · 5.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Reference — python-github-webhook 1.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="python-github-webhook 1.0 documentation" href="index.html" />
<link rel="next" title="References" href="references.html" />
<link rel="prev" title="Welcome to python-github-webhook’s documentation!" href="index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="references.html" title="References"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to python-github-webhook’s documentation!"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">python-github-webhook 1.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="github_webhook.Webhook">
<em class="property">class </em><code class="descclassname">github_webhook.</code><code class="descname">Webhook</code><span class="sig-paren">(</span><em>app</em>, <em>endpoint='/postreceive'</em>, <em>secret=None</em><span class="sig-paren">)</span><a class="headerlink" href="#github_webhook.Webhook" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a webhook on the given <code class="code docutils literal"><span class="pre">app</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>app</strong> – Flask app that will host the webhook</li>
<li><strong>endpoint</strong> – the endpoint for the registered URL rule</li>
<li><strong>secret</strong> – Optional secret, used to authenticate the hook comes from Github</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="github_webhook.Webhook.hook">
<code class="descname">hook</code><span class="sig-paren">(</span><em>event_type='push'</em><span class="sig-paren">)</span><a class="headerlink" href="#github_webhook.Webhook.hook" title="Permalink to this definition">¶</a></dt>
<dd><p>Registers a function as a hook. Multiple hooks can be registered for a given type, but the
order in which they are invoke is unspecified.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event_type</strong> – The event type this hook will be invoked for.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to python-github-webhook’s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="references.html"
title="next chapter">References</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api_reference.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="references.html" title="References"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to python-github-webhook’s documentation!"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">python-github-webhook 1.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, Bloomberg LP.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.
</div>
</body>
</html>