blob: 8221bb5f12a8ccc03bdbc040a8a1de04a369710f [file] [log] [blame]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dialogflow_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3.projects.locations.agents.webhooks.html">webhooks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a webhook in the specified agent.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes the specified webhook.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves the specified webhook.</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Returns the list of all webhooks in the specified agent.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates the specified webhook.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
106 <pre>Creates a webhook in the specified agent.
107
108Args:
109 parent: string, Required. The agent to create a webhook for. Format: `projects//locations//agents/`. (required)
110 body: object, The request body.
111 The object takes the form of:
112
113{ # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
114 &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
115 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
116 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
117 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
118 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
119 &quot;a_key&quot;: &quot;A String&quot;,
120 },
121 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
122 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
123 },
124 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700125 &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
126 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
127 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
128 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
129 &quot;a_key&quot;: &quot;A String&quot;,
130 },
131 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
132 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
133 },
134 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
135 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800136 &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
137}
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
148 &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
149 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
150 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
151 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
152 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
153 &quot;a_key&quot;: &quot;A String&quot;,
154 },
155 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
156 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
157 },
158 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700159 &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
160 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
161 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
162 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
163 &quot;a_key&quot;: &quot;A String&quot;,
164 },
165 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
166 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
167 },
168 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
169 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800170 &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
171}</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
176 <pre>Deletes the specified webhook.
177
178Args:
179 name: string, Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`. (required)
180 force: boolean, This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
189 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
190}</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="get">get(name, x__xgafv=None)</code>
195 <pre>Retrieves the specified webhook.
196
197Args:
198 name: string, Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`. (required)
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
207 { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
208 &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
209 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
210 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
211 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
212 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
213 &quot;a_key&quot;: &quot;A String&quot;,
214 },
215 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
216 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
217 },
218 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700219 &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
220 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
221 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
222 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
223 &quot;a_key&quot;: &quot;A String&quot;,
224 },
225 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
226 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
227 },
228 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
229 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800230 &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
231}</pre>
232</div>
233
234<div class="method">
235 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
236 <pre>Returns the list of all webhooks in the specified agent.
237
238Args:
239 parent: string, Required. The agent to list all webhooks for. Format: `projects//locations//agents/`. (required)
240 pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
241 pageToken: string, The next_page_token value returned from a previous list request.
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247Returns:
248 An object of the form:
249
250 { # The response message for Webhooks.ListWebhooks.
251 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
252 &quot;webhooks&quot;: [ # The list of webhooks. There will be a maximum number of items returned based on the page_size field in the request.
253 { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
254 &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
255 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
256 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
257 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
258 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
259 &quot;a_key&quot;: &quot;A String&quot;,
260 },
261 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
262 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
263 },
264 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700265 &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
266 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
267 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
268 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
269 &quot;a_key&quot;: &quot;A String&quot;,
270 },
271 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
272 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
273 },
274 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
275 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800276 &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
277 },
278 ],
279}</pre>
280</div>
281
282<div class="method">
283 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
284 <pre>Retrieves the next page of results.
285
286Args:
287 previous_request: The request for the previous page. (required)
288 previous_response: The response from the request for the previous page. (required)
289
290Returns:
291 A request object that you can call &#x27;execute()&#x27; on to request the next
292 page. Returns None if there are no more items in the collection.
293 </pre>
294</div>
295
296<div class="method">
297 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
298 <pre>Updates the specified webhook.
299
300Args:
301 name: string, The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`. (required)
302 body: object, The request body.
303 The object takes the form of:
304
305{ # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
306 &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
307 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
308 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
309 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
310 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
311 &quot;a_key&quot;: &quot;A String&quot;,
312 },
313 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
314 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
315 },
316 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700317 &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
318 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
319 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
320 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
321 &quot;a_key&quot;: &quot;A String&quot;,
322 },
323 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
324 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
325 },
326 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
327 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800328 &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
329}
330
331 updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
332 x__xgafv: string, V1 error format.
333 Allowed values
334 1 - v1 error format
335 2 - v2 error format
336
337Returns:
338 An object of the form:
339
340 { # Webhooks host the developer&#x27;s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow&#x27;s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
341 &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
342 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
343 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
344 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
345 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
346 &quot;a_key&quot;: &quot;A String&quot;,
347 },
348 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
349 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
350 },
351 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700352 &quot;serviceDirectory&quot;: { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
353 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
354 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
355 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
356 &quot;a_key&quot;: &quot;A String&quot;,
357 },
358 &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
359 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
360 },
361 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
362 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800363 &quot;timeout&quot;: &quot;A String&quot;, # Webhook execution timeout. Execution is considered failed if Dialogflow doesn&#x27;t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
364}</pre>
365</div>
366
367</body></html>