Updates the specified webhook.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: dialogflow3 --scope <scope> projects locations-agents-webhooks-patch ...

Required Scalar Argument

  • <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 Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudDialogflowCxV3Webhook:
  disabled: boolean
  display-name: string
  generic-web-service:
    allowed-ca-certs: [string]
    http-method: string
    parameter-mapping: { string: string }
    password: string
    request-body: string
    request-headers: { string: string }
    uri: string
    username: string
    webhook-type: string
  name: string
  service-directory:
    generic-web-service:
      allowed-ca-certs: [string]
      http-method: string
      parameter-mapping: { string: string }
      password: string
      request-body: string
      request-headers: { string: string }
      uri: string
      username: string
      webhook-type: string
    service: string
  timeout: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . disabled=true
    • Indicates whether the webhook is disabled.
  • display-name=gubergren
    • Required. The human-readable name of the webhook, unique within the agent.
  • generic-web-service allowed-ca-certs=sed
    • 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's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 &#34;\nsubjectAltName=&#39;DNS:www.example.com&#39;&#34;)
    • Each invocation of this argument appends the given value to the array.
  • http-method=justo
    • Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
  • parameter-mapping=key=amet
    • Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
    • the value will be associated with the given key
  • password=sed
    • The password for HTTP Basic authentication.
  • request-body=ut
    • Optional. Defines a custom JSON object as request body to send to flexible webhook.
  • request-headers=key=et
    • The HTTP request headers to send together with webhook requests.
    • the value will be associated with the given key
  • uri=kasd
    • Required. The webhook URI for receiving POST requests. It must use https protocol.
  • username=gubergren
    • The user name for HTTP Basic authentication.

  • webhook-type=et

    • Optional. Type of the webhook.

  • .. name=at

    • The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.
  • service-directory.generic-web-service allowed-ca-certs=ut
    • 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's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 &#34;\nsubjectAltName=&#39;DNS:www.example.com&#39;&#34;)
    • Each invocation of this argument appends the given value to the array.
  • http-method=consetetur
    • Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
  • parameter-mapping=key=at
    • Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
    • the value will be associated with the given key
  • password=et
    • The password for HTTP Basic authentication.
  • request-body=dolor
    • Optional. Defines a custom JSON object as request body to send to flexible webhook.
  • request-headers=key=clita
    • The HTTP request headers to send together with webhook requests.
    • the value will be associated with the given key
  • uri=tempor
    • Required. The webhook URI for receiving POST requests. It must use https protocol.
  • username=amet
    • The user name for HTTP Basic authentication.

  • webhook-type=dolor

    • Optional. Type of the webhook.

  • .. service=dolore

    • Required. The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

  • .. timeout=clita

    • 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.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").