• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.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;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
118      &quot;A String&quot;,
119    ],
120    &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
121    &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
122      &quot;a_key&quot;: &quot;A String&quot;,
123    },
124    &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
125    &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
126  },
127  &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/`.
128  &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.
129    &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
130      &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
131        &quot;A String&quot;,
132      ],
133      &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
134      &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
135        &quot;a_key&quot;: &quot;A String&quot;,
136      },
137      &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
138      &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
139    },
140    &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.
141  },
142  &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.
143}
144
145  x__xgafv: string, V1 error format.
146    Allowed values
147      1 - v1 error format
148      2 - v2 error format
149
150Returns:
151  An object of the form:
152
153    { # 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.
154  &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
155  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
156  &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
157    &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
158      &quot;A String&quot;,
159    ],
160    &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
161    &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
162      &quot;a_key&quot;: &quot;A String&quot;,
163    },
164    &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
165    &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
166  },
167  &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/`.
168  &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.
169    &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
170      &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
171        &quot;A String&quot;,
172      ],
173      &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
174      &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
175        &quot;a_key&quot;: &quot;A String&quot;,
176      },
177      &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
178      &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
179    },
180    &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.
181  },
182  &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.
183}</pre>
184</div>
185
186<div class="method">
187    <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
188  <pre>Deletes the specified webhook.
189
190Args:
191  name: string, Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`. (required)
192  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).
193  x__xgafv: string, V1 error format.
194    Allowed values
195      1 - v1 error format
196      2 - v2 error format
197
198Returns:
199  An object of the form:
200
201    { # 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 `{}`.
202}</pre>
203</div>
204
205<div class="method">
206    <code class="details" id="get">get(name, x__xgafv=None)</code>
207  <pre>Retrieves the specified webhook.
208
209Args:
210  name: string, Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`. (required)
211  x__xgafv: string, V1 error format.
212    Allowed values
213      1 - v1 error format
214      2 - v2 error format
215
216Returns:
217  An object of the form:
218
219    { # 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.
220  &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
221  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
222  &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
223    &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
224      &quot;A String&quot;,
225    ],
226    &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
227    &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
228      &quot;a_key&quot;: &quot;A String&quot;,
229    },
230    &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
231    &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
232  },
233  &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/`.
234  &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.
235    &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
236      &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
237        &quot;A String&quot;,
238      ],
239      &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
240      &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
241        &quot;a_key&quot;: &quot;A String&quot;,
242      },
243      &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
244      &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
245    },
246    &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.
247  },
248  &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.
249}</pre>
250</div>
251
252<div class="method">
253    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
254  <pre>Returns the list of all webhooks in the specified agent.
255
256Args:
257  parent: string, Required. The agent to list all webhooks for. Format: `projects//locations//agents/`. (required)
258  pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
259  pageToken: string, The next_page_token value returned from a previous list request.
260  x__xgafv: string, V1 error format.
261    Allowed values
262      1 - v1 error format
263      2 - v2 error format
264
265Returns:
266  An object of the form:
267
268    { # The response message for Webhooks.ListWebhooks.
269  &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.
270  &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.
271    { # 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.
272      &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
273      &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
274      &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
275        &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
276          &quot;A String&quot;,
277        ],
278        &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
279        &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
280          &quot;a_key&quot;: &quot;A String&quot;,
281        },
282        &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
283        &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
284      },
285      &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/`.
286      &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.
287        &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
288          &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
289            &quot;A String&quot;,
290          ],
291          &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
292          &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
293            &quot;a_key&quot;: &quot;A String&quot;,
294          },
295          &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
296          &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
297        },
298        &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.
299      },
300      &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.
301    },
302  ],
303}</pre>
304</div>
305
306<div class="method">
307    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
308  <pre>Retrieves the next page of results.
309
310Args:
311  previous_request: The request for the previous page. (required)
312  previous_response: The response from the request for the previous page. (required)
313
314Returns:
315  A request object that you can call &#x27;execute()&#x27; on to request the next
316  page. Returns None if there are no more items in the collection.
317    </pre>
318</div>
319
320<div class="method">
321    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
322  <pre>Updates the specified webhook.
323
324Args:
325  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)
326  body: object, The request body.
327    The object takes the form of:
328
329{ # 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.
330  &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
331  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
332  &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
333    &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
334      &quot;A String&quot;,
335    ],
336    &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
337    &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
338      &quot;a_key&quot;: &quot;A String&quot;,
339    },
340    &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
341    &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
342  },
343  &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/`.
344  &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.
345    &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
346      &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
347        &quot;A String&quot;,
348      ],
349      &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
350      &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
351        &quot;a_key&quot;: &quot;A String&quot;,
352      },
353      &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
354      &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
355    },
356    &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.
357  },
358  &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.
359}
360
361  updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
362  x__xgafv: string, V1 error format.
363    Allowed values
364      1 - v1 error format
365      2 - v2 error format
366
367Returns:
368  An object of the form:
369
370    { # 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.
371  &quot;disabled&quot;: True or False, # Indicates whether the webhook is disabled.
372  &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the webhook, unique within the agent.
373  &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
374    &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
375      &quot;A String&quot;,
376    ],
377    &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
378    &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
379      &quot;a_key&quot;: &quot;A String&quot;,
380    },
381    &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
382    &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
383  },
384  &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/`.
385  &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.
386    &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
387      &quot;allowedCaCerts&quot;: [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;)
388        &quot;A String&quot;,
389      ],
390      &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
391      &quot;requestHeaders&quot;: { # The HTTP request headers to send together with webhook requests.
392        &quot;a_key&quot;: &quot;A String&quot;,
393      },
394      &quot;uri&quot;: &quot;A String&quot;, # Required. The webhook URI for receiving POST requests. It must use https protocol.
395      &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
396    },
397    &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.
398  },
399  &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.
400}</pre>
401</div>
402
403</body></html>