Blame - docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html - platform/external/python/google-api-python-client

<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

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

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

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

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Retrieves the specified webhook.</p>

89

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

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

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

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

106

<pre>Creates a webhook in the specified agent.

107

108

Args:

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's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

114

"disabled": True or False, # Indicates whether the webhook is disabled.

115

"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.

116

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

117

"password": "A String", # The password for HTTP Basic authentication.

118

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

119

"a_key": "A String",

120

},

121

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

122

"username": "A String", # The user name for HTTP Basic authentication.

123

},

124

"name": "A String", # 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-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

125

"serviceDirectory": { # 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

"genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.

127

"password": "A String", # The password for HTTP Basic authentication.

128

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

129

"a_key": "A String",

130

},

131

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

132

"username": "A String", # The user name for HTTP Basic authentication.

133

},

134

"service": "A String", # 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-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

136

"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn'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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

146

147

{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

148

"disabled": True or False, # Indicates whether the webhook is disabled.

149

"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.

150

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

151

"password": "A String", # The password for HTTP Basic authentication.

152

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

153

"a_key": "A String",

154

},

155

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

156

"username": "A String", # The user name for HTTP Basic authentication.

157

},

158

"name": "A String", # 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-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

159

"serviceDirectory": { # 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

"genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.

161

"password": "A String", # The password for HTTP Basic authentication.

162

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

163

"a_key": "A String",

164

},

165

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

166

"username": "A String", # The user name for HTTP Basic authentication.

167

},

168

"service": "A String", # 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-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

170

"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

}</pre>

</div>

<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>

176

<pre>Deletes the specified webhook.

177

178

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

195

<pre>Retrieves the specified webhook.

196

197

Args:

198

name: string, Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`. (required)

199

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

206

207

{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

208

"disabled": True or False, # Indicates whether the webhook is disabled.

209

"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.

210

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

211

"password": "A String", # The password for HTTP Basic authentication.

212

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

213

"a_key": "A String",

214

},

215

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

216

"username": "A String", # The user name for HTTP Basic authentication.

217

},

218

"name": "A String", # 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-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

219

"serviceDirectory": { # 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

"genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.

221

"password": "A String", # The password for HTTP Basic authentication.

222

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

223

"a_key": "A String",

224

},

225

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

226

"username": "A String", # The user name for HTTP Basic authentication.

227

},

228

"service": "A String", # 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-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

230

"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

}</pre>

</div>

<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

238

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

249

250

{ # The response message for Webhooks.ListWebhooks.

251

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

252

"webhooks": [ # 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's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

254

"disabled": True or False, # Indicates whether the webhook is disabled.

255

"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.

256

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

257

"password": "A String", # The password for HTTP Basic authentication.

258

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

259

"a_key": "A String",

260

},

261

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

262

"username": "A String", # The user name for HTTP Basic authentication.

263

},

264

"name": "A String", # 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-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

265

"serviceDirectory": { # 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

"genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.

267

"password": "A String", # The password for HTTP Basic authentication.

268

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

269

"a_key": "A String",

270

},

271

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

272

"username": "A String", # The user name for HTTP Basic authentication.

273

},

274

"service": "A String", # 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-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

276

"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

284

<pre>Retrieves the next page of results.

285

286

Args:

287

previous_request: The request for the previous page. (required)

288

previous_response: The response from the request for the previous page. (required)

289

290

Returns:

291

A request object that you can call 'execute()' on to request the next

292

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

298

<pre>Updates the specified webhook.

299

300

Args:

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's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

306

"disabled": True or False, # Indicates whether the webhook is disabled.

307

"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.

308

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

309

"password": "A String", # The password for HTTP Basic authentication.

310

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

311

"a_key": "A String",

312

},

313

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

314

"username": "A String", # The user name for HTTP Basic authentication.

315

},

316

"name": "A String", # 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-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

317

"serviceDirectory": { # 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

"genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.

319

"password": "A String", # The password for HTTP Basic authentication.

320

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

321

"a_key": "A String",

322

},

323

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

324

"username": "A String", # The user name for HTTP Basic authentication.

325

},

326

"service": "A String", # 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-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

328

"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn'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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

339

340

{ # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

341

"disabled": True or False, # Indicates whether the webhook is disabled.

342

"displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.

343

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

344

"password": "A String", # The password for HTTP Basic authentication.

345

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

346

"a_key": "A String",

347

},

348

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

349

"username": "A String", # The user name for HTTP Basic authentication.

350

},

351

"name": "A String", # 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-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

352

"serviceDirectory": { # 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

"genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.

354

"password": "A String", # The password for HTTP Basic authentication.

355

"requestHeaders": { # The HTTP request headers to send together with webhook requests.

356

"a_key": "A String",

357

},

358

"uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.

359

"username": "A String", # The user name for HTTP Basic authentication.

360

},

361

"service": "A String", # 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-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

363

"timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

}</pre>

</div>

</body></html>