Class: Google::Cloud::Dialogflow::CX::V3::Webhook

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb

Overview

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.

Defined Under Namespace

Classes: GenericWebService, ServiceDirectoryConfig

Instance Attribute Summary collapse

Instance Attribute Details

#disabled ⇒ ::Boolean

Returns Indicates whether the webhook is disabled.

Returns:

  • (::Boolean) —

    Indicates whether the webhook is disabled.



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 56

class Webhook
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook
  #     requests.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::Array<::String>]
  #     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 <(printf "\nsubjectAltName='DNS:www.example.com'")
  #     ```
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ParameterMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the type of webhook configuration.
    module WebhookType
      # Default value. This value is unused.
      WEBHOOK_TYPE_UNSPECIFIED = 0

      # Represents a standard webhook.
      STANDARD = 1

      # Represents a flexible webhook.
      FLEXIBLE = 2
    end

    # HTTP method to use when calling webhooks.
    module HttpMethod
      # HTTP method not specified.
      HTTP_METHOD_UNSPECIFIED = 0

      # HTTP POST Method.
      POST = 1

      # HTTP GET Method.
      GET = 2

      # HTTP HEAD Method.
      HEAD = 3

      # HTTP PUT Method.
      PUT = 4

      # HTTP DELETE Method.
      DELETE = 5

      # HTTP PATCH Method.
      PATCH = 6

      # HTTP OPTIONS Method.
      OPTIONS = 7
    end
  end

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/namespaces/<Namespace ID>/services/<Service ID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the webhook, unique within the agent.

Returns:

  • (::String) —

    Required. The human-readable name of the webhook, unique within the agent.



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 56

class Webhook
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook
  #     requests.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::Array<::String>]
  #     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 <(printf "\nsubjectAltName='DNS:www.example.com'")
  #     ```
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ParameterMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the type of webhook configuration.
    module WebhookType
      # Default value. This value is unused.
      WEBHOOK_TYPE_UNSPECIFIED = 0

      # Represents a standard webhook.
      STANDARD = 1

      # Represents a flexible webhook.
      FLEXIBLE = 2
    end

    # HTTP method to use when calling webhooks.
    module HttpMethod
      # HTTP method not specified.
      HTTP_METHOD_UNSPECIFIED = 0

      # HTTP POST Method.
      POST = 1

      # HTTP GET Method.
      GET = 2

      # HTTP HEAD Method.
      HEAD = 3

      # HTTP PUT Method.
      PUT = 4

      # HTTP DELETE Method.
      DELETE = 5

      # HTTP PATCH Method.
      PATCH = 6

      # HTTP OPTIONS Method.
      OPTIONS = 7
    end
  end

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/namespaces/<Namespace ID>/services/<Service ID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#generic_web_service ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService

Returns Configuration for a generic web service.

Returns:



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 56

class Webhook
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook
  #     requests.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::Array<::String>]
  #     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 <(printf "\nsubjectAltName='DNS:www.example.com'")
  #     ```
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ParameterMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the type of webhook configuration.
    module WebhookType
      # Default value. This value is unused.
      WEBHOOK_TYPE_UNSPECIFIED = 0

      # Represents a standard webhook.
      STANDARD = 1

      # Represents a flexible webhook.
      FLEXIBLE = 2
    end

    # HTTP method to use when calling webhooks.
    module HttpMethod
      # HTTP method not specified.
      HTTP_METHOD_UNSPECIFIED = 0

      # HTTP POST Method.
      POST = 1

      # HTTP GET Method.
      GET = 2

      # HTTP HEAD Method.
      HEAD = 3

      # HTTP PUT Method.
      PUT = 4

      # HTTP DELETE Method.
      DELETE = 5

      # HTTP PATCH Method.
      PATCH = 6

      # HTTP OPTIONS Method.
      OPTIONS = 7
    end
  end

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/namespaces/<Namespace ID>/services/<Service ID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Returns:

  • (::String) —

    The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 56

class Webhook
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook
  #     requests.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::Array<::String>]
  #     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 <(printf "\nsubjectAltName='DNS:www.example.com'")
  #     ```
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ParameterMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the type of webhook configuration.
    module WebhookType
      # Default value. This value is unused.
      WEBHOOK_TYPE_UNSPECIFIED = 0

      # Represents a standard webhook.
      STANDARD = 1

      # Represents a flexible webhook.
      FLEXIBLE = 2
    end

    # HTTP method to use when calling webhooks.
    module HttpMethod
      # HTTP method not specified.
      HTTP_METHOD_UNSPECIFIED = 0

      # HTTP POST Method.
      POST = 1

      # HTTP GET Method.
      GET = 2

      # HTTP HEAD Method.
      HEAD = 3

      # HTTP PUT Method.
      PUT = 4

      # HTTP DELETE Method.
      DELETE = 5

      # HTTP PATCH Method.
      PATCH = 6

      # HTTP OPTIONS Method.
      OPTIONS = 7
    end
  end

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/namespaces/<Namespace ID>/services/<Service ID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_directory ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig

Returns Configuration for a Service Directory service.

Returns:



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 56

class Webhook
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook
  #     requests.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::Array<::String>]
  #     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 <(printf "\nsubjectAltName='DNS:www.example.com'")
  #     ```
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ParameterMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the type of webhook configuration.
    module WebhookType
      # Default value. This value is unused.
      WEBHOOK_TYPE_UNSPECIFIED = 0

      # Represents a standard webhook.
      STANDARD = 1

      # Represents a flexible webhook.
      FLEXIBLE = 2
    end

    # HTTP method to use when calling webhooks.
    module HttpMethod
      # HTTP method not specified.
      HTTP_METHOD_UNSPECIFIED = 0

      # HTTP POST Method.
      POST = 1

      # HTTP GET Method.
      GET = 2

      # HTTP HEAD Method.
      HEAD = 3

      # HTTP PUT Method.
      PUT = 4

      # HTTP DELETE Method.
      DELETE = 5

      # HTTP PATCH Method.
      PATCH = 6

      # HTTP OPTIONS Method.
      OPTIONS = 7
    end
  end

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/namespaces/<Namespace ID>/services/<Service ID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#timeout ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

    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.



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 56

class Webhook
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook
  #     requests.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::Array<::String>]
  #     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 <(printf "\nsubjectAltName='DNS:www.example.com'")
  #     ```
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ParameterMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the type of webhook configuration.
    module WebhookType
      # Default value. This value is unused.
      WEBHOOK_TYPE_UNSPECIFIED = 0

      # Represents a standard webhook.
      STANDARD = 1

      # Represents a flexible webhook.
      FLEXIBLE = 2
    end

    # HTTP method to use when calling webhooks.
    module HttpMethod
      # HTTP method not specified.
      HTTP_METHOD_UNSPECIFIED = 0

      # HTTP POST Method.
      POST = 1

      # HTTP GET Method.
      GET = 2

      # HTTP HEAD Method.
      HEAD = 3

      # HTTP PUT Method.
      PUT = 4

      # HTTP DELETE Method.
      DELETE = 5

      # HTTP PATCH Method.
      PATCH = 6

      # HTTP OPTIONS Method.
      OPTIONS = 7
    end
  end

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/namespaces/<Namespace ID>/services/<Service ID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end