Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3
  6. Webhook

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v3.Webhook

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a webhook in the specified agent.

Create Webhook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
@overload
def Webhook(resource_name: str,
            args: WebhookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            agent_id: Optional[str] = None,
            display_name: Optional[str] = None,
            disabled: Optional[bool] = None,
            generic_web_service: Optional[GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            service_directory: Optional[GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs] = None,
            timeout: Optional[str] = None)
func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

type: google-native:dialogflow/v3:Webhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WebhookArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WebhookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WebhookArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var webhookResource = new GoogleNative.Dialogflow.V3.Webhook("webhookResource", new()
{
    AgentId = "string",
    DisplayName = "string",
    Disabled = false,
    GenericWebService = new GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs
    {
        Uri = "string",
        AllowedCaCerts = new[]
        {
            "string",
        },
        HttpMethod = GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod.HttpMethodUnspecified,
        ParameterMapping = 
        {
            { "string", "string" },
        },
        Password = "string",
        RequestBody = "string",
        RequestHeaders = 
        {
            { "string", "string" },
        },
        Username = "string",
        WebhookType = GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType.WebhookTypeUnspecified,
    },
    Location = "string",
    Name = "string",
    Project = "string",
    ServiceDirectory = new GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs
    {
        Service = "string",
        GenericWebService = new GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs
        {
            Uri = "string",
            AllowedCaCerts = new[]
            {
                "string",
            },
            HttpMethod = GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod.HttpMethodUnspecified,
            ParameterMapping = 
            {
                { "string", "string" },
            },
            Password = "string",
            RequestBody = "string",
            RequestHeaders = 
            {
                { "string", "string" },
            },
            Username = "string",
            WebhookType = GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType.WebhookTypeUnspecified,
        },
    },
    Timeout = "string",
});
Copy
example, err := dialogflowv3.NewWebhook(ctx, "webhookResource", &dialogflowv3.WebhookArgs{
	AgentId:     pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Disabled:    pulumi.Bool(false),
	GenericWebService: &dialogflow.GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs{
		Uri: pulumi.String("string"),
		AllowedCaCerts: pulumi.StringArray{
			pulumi.String("string"),
		},
		HttpMethod: dialogflowv3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodHttpMethodUnspecified,
		ParameterMapping: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Password:    pulumi.String("string"),
		RequestBody: pulumi.String("string"),
		RequestHeaders: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Username:    pulumi.String("string"),
		WebhookType: dialogflowv3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookTypeWebhookTypeUnspecified,
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
	ServiceDirectory: &dialogflow.GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs{
		Service: pulumi.String("string"),
		GenericWebService: &dialogflow.GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs{
			Uri: pulumi.String("string"),
			AllowedCaCerts: pulumi.StringArray{
				pulumi.String("string"),
			},
			HttpMethod: dialogflowv3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodHttpMethodUnspecified,
			ParameterMapping: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Password:    pulumi.String("string"),
			RequestBody: pulumi.String("string"),
			RequestHeaders: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Username:    pulumi.String("string"),
			WebhookType: dialogflowv3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookTypeWebhookTypeUnspecified,
		},
	},
	Timeout: pulumi.String("string"),
})
Copy
var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .agentId("string")
    .displayName("string")
    .disabled(false)
    .genericWebService(GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs.builder()
        .uri("string")
        .allowedCaCerts("string")
        .httpMethod("HTTP_METHOD_UNSPECIFIED")
        .parameterMapping(Map.of("string", "string"))
        .password("string")
        .requestBody("string")
        .requestHeaders(Map.of("string", "string"))
        .username("string")
        .webhookType("WEBHOOK_TYPE_UNSPECIFIED")
        .build())
    .location("string")
    .name("string")
    .project("string")
    .serviceDirectory(GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs.builder()
        .service("string")
        .genericWebService(GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs.builder()
            .uri("string")
            .allowedCaCerts("string")
            .httpMethod("HTTP_METHOD_UNSPECIFIED")
            .parameterMapping(Map.of("string", "string"))
            .password("string")
            .requestBody("string")
            .requestHeaders(Map.of("string", "string"))
            .username("string")
            .webhookType("WEBHOOK_TYPE_UNSPECIFIED")
            .build())
        .build())
    .timeout("string")
    .build());
Copy
webhook_resource = google_native.dialogflow.v3.Webhook("webhookResource",
    agent_id="string",
    display_name="string",
    disabled=False,
    generic_web_service={
        "uri": "string",
        "allowed_ca_certs": ["string"],
        "http_method": google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod.HTTP_METHOD_UNSPECIFIED,
        "parameter_mapping": {
            "string": "string",
        },
        "password": "string",
        "request_body": "string",
        "request_headers": {
            "string": "string",
        },
        "username": "string",
        "webhook_type": google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType.WEBHOOK_TYPE_UNSPECIFIED,
    },
    location="string",
    name="string",
    project="string",
    service_directory={
        "service": "string",
        "generic_web_service": {
            "uri": "string",
            "allowed_ca_certs": ["string"],
            "http_method": google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod.HTTP_METHOD_UNSPECIFIED,
            "parameter_mapping": {
                "string": "string",
            },
            "password": "string",
            "request_body": "string",
            "request_headers": {
                "string": "string",
            },
            "username": "string",
            "webhook_type": google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType.WEBHOOK_TYPE_UNSPECIFIED,
        },
    },
    timeout="string")
Copy
const webhookResource = new google_native.dialogflow.v3.Webhook("webhookResource", {
    agentId: "string",
    displayName: "string",
    disabled: false,
    genericWebService: {
        uri: "string",
        allowedCaCerts: ["string"],
        httpMethod: google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod.HttpMethodUnspecified,
        parameterMapping: {
            string: "string",
        },
        password: "string",
        requestBody: "string",
        requestHeaders: {
            string: "string",
        },
        username: "string",
        webhookType: google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType.WebhookTypeUnspecified,
    },
    location: "string",
    name: "string",
    project: "string",
    serviceDirectory: {
        service: "string",
        genericWebService: {
            uri: "string",
            allowedCaCerts: ["string"],
            httpMethod: google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod.HttpMethodUnspecified,
            parameterMapping: {
                string: "string",
            },
            password: "string",
            requestBody: "string",
            requestHeaders: {
                string: "string",
            },
            username: "string",
            webhookType: google_native.dialogflow.v3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType.WebhookTypeUnspecified,
        },
    },
    timeout: "string",
});
Copy
type: google-native:dialogflow/v3:Webhook
properties:
    agentId: string
    disabled: false
    displayName: string
    genericWebService:
        allowedCaCerts:
            - string
        httpMethod: HTTP_METHOD_UNSPECIFIED
        parameterMapping:
            string: string
        password: string
        requestBody: string
        requestHeaders:
            string: string
        uri: string
        username: string
        webhookType: WEBHOOK_TYPE_UNSPECIFIED
    location: string
    name: string
    project: string
    serviceDirectory:
        genericWebService:
            allowedCaCerts:
                - string
            httpMethod: HTTP_METHOD_UNSPECIFIED
            parameterMapping:
                string: string
            password: string
            requestBody: string
            requestHeaders:
                string: string
            uri: string
            username: string
            webhookType: WEBHOOK_TYPE_UNSPECIFIED
        service: string
    timeout: string
Copy

Webhook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Webhook resource accepts the following input properties:

AgentId
This property is required.
Changes to this property will trigger replacement.
string
DisplayName This property is required. string
The human-readable name of the webhook, unique within the agent.
Disabled bool
Indicates whether the webhook is disabled.
GenericWebService Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebService
Configuration for a generic web service.
Location Changes to this property will trigger replacement. string
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/.
Project Changes to this property will trigger replacement. string
ServiceDirectory Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
Configuration for a Service Directory service.
Timeout 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.
AgentId
This property is required.
Changes to this property will trigger replacement.
string
DisplayName This property is required. string
The human-readable name of the webhook, unique within the agent.
Disabled bool
Indicates whether the webhook is disabled.
GenericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs
Configuration for a generic web service.
Location Changes to this property will trigger replacement. string
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/.
Project Changes to this property will trigger replacement. string
ServiceDirectory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs
Configuration for a Service Directory service.
Timeout 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.
agentId
This property is required.
Changes to this property will trigger replacement.
String
displayName This property is required. String
The human-readable name of the webhook, unique within the agent.
disabled Boolean
Indicates whether the webhook is disabled.
genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService
Configuration for a generic web service.
location Changes to this property will trigger replacement. String
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/.
project Changes to this property will trigger replacement. String
serviceDirectory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
Configuration for a Service Directory service.
timeout 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.
agentId
This property is required.
Changes to this property will trigger replacement.
string
displayName This property is required. string
The human-readable name of the webhook, unique within the agent.
disabled boolean
Indicates whether the webhook is disabled.
genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService
Configuration for a generic web service.
location Changes to this property will trigger replacement. string
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/.
project Changes to this property will trigger replacement. string
serviceDirectory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
Configuration for a Service Directory service.
timeout 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.
agent_id
This property is required.
Changes to this property will trigger replacement.
str
display_name This property is required. str
The human-readable name of the webhook, unique within the agent.
disabled bool
Indicates whether the webhook is disabled.
generic_web_service GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs
Configuration for a generic web service.
location Changes to this property will trigger replacement. str
name str
The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.
project Changes to this property will trigger replacement. str
service_directory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs
Configuration for a Service Directory service.
timeout str
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.
agentId
This property is required.
Changes to this property will trigger replacement.
String
displayName This property is required. String
The human-readable name of the webhook, unique within the agent.
disabled Boolean
Indicates whether the webhook is disabled.
genericWebService Property Map
Configuration for a generic web service.
location Changes to this property will trigger replacement. String
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/.
project Changes to this property will trigger replacement. String
serviceDirectory Property Map
Configuration for a Service Directory service.
timeout 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Webhook resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

GoogleCloudDialogflowCxV3WebhookGenericWebService
, GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs

Uri This property is required. string
The webhook URI for receiving POST requests. It must use https protocol.
AllowedCaCerts List<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'")
HttpMethod Pulumi.GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
ParameterMapping Dictionary<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
Password string
The password for HTTP Basic authentication.
RequestBody string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
RequestHeaders Dictionary<string, string>
The HTTP request headers to send together with webhook requests.
Username string
The user name for HTTP Basic authentication.
WebhookType Pulumi.GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType
Optional. Type of the webhook.
Uri This property is required. string
The webhook URI for receiving POST requests. It must use https protocol.
AllowedCaCerts []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'")
HttpMethod GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
ParameterMapping 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
Password string
The password for HTTP Basic authentication.
RequestBody string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
RequestHeaders map[string]string
The HTTP request headers to send together with webhook requests.
Username string
The user name for HTTP Basic authentication.
WebhookType GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType
Optional. Type of the webhook.
uri This property is required. String
The webhook URI for receiving POST requests. It must use https protocol.
allowedCaCerts List<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'")
httpMethod GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameterMapping 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
password String
The password for HTTP Basic authentication.
requestBody String
Optional. Defines a custom JSON object as request body to send to flexible webhook.
requestHeaders Map<String,String>
The HTTP request headers to send together with webhook requests.
username String
The user name for HTTP Basic authentication.
webhookType GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType
Optional. Type of the webhook.
uri This property is required. string
The webhook URI for receiving POST requests. It must use https protocol.
allowedCaCerts 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'")
httpMethod GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameterMapping {[key: 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
password string
The password for HTTP Basic authentication.
requestBody string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
requestHeaders {[key: string]: string}
The HTTP request headers to send together with webhook requests.
username string
The user name for HTTP Basic authentication.
webhookType GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType
Optional. Type of the webhook.
uri This property is required. str
The webhook URI for receiving POST requests. It must use https protocol.
allowed_ca_certs Sequence[str]
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'")
http_method GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameter_mapping Mapping[str, str]
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
password str
The password for HTTP Basic authentication.
request_body str
Optional. Defines a custom JSON object as request body to send to flexible webhook.
request_headers Mapping[str, str]
The HTTP request headers to send together with webhook requests.
username str
The user name for HTTP Basic authentication.
webhook_type GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType
Optional. Type of the webhook.
uri This property is required. String
The webhook URI for receiving POST requests. It must use https protocol.
allowedCaCerts List<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'")
httpMethod "HTTP_METHOD_UNSPECIFIED" | "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS"
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameterMapping Map<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
password String
The password for HTTP Basic authentication.
requestBody String
Optional. Defines a custom JSON object as request body to send to flexible webhook.
requestHeaders Map<String>
The HTTP request headers to send together with webhook requests.
username String
The user name for HTTP Basic authentication.
webhookType "WEBHOOK_TYPE_UNSPECIFIED" | "STANDARD" | "FLEXIBLE"
Optional. Type of the webhook.

GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethod
, GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodArgs

HttpMethodUnspecified
HTTP_METHOD_UNSPECIFIEDHTTP method not specified.
Post
POSTHTTP POST Method.
Get
GETHTTP GET Method.
Head
HEADHTTP HEAD Method.
Put
PUTHTTP PUT Method.
Delete
DELETEHTTP DELETE Method.
Patch
PATCHHTTP PATCH Method.
Options
OPTIONSHTTP OPTIONS Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodHttpMethodUnspecified
HTTP_METHOD_UNSPECIFIEDHTTP method not specified.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodPost
POSTHTTP POST Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodGet
GETHTTP GET Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodHead
HEADHTTP HEAD Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodPut
PUTHTTP PUT Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodDelete
DELETEHTTP DELETE Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodPatch
PATCHHTTP PATCH Method.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceHttpMethodOptions
OPTIONSHTTP OPTIONS Method.
HttpMethodUnspecified
HTTP_METHOD_UNSPECIFIEDHTTP method not specified.
Post
POSTHTTP POST Method.
Get
GETHTTP GET Method.
Head
HEADHTTP HEAD Method.
Put
PUTHTTP PUT Method.
Delete
DELETEHTTP DELETE Method.
Patch
PATCHHTTP PATCH Method.
Options
OPTIONSHTTP OPTIONS Method.
HttpMethodUnspecified
HTTP_METHOD_UNSPECIFIEDHTTP method not specified.
Post
POSTHTTP POST Method.
Get
GETHTTP GET Method.
Head
HEADHTTP HEAD Method.
Put
PUTHTTP PUT Method.
Delete
DELETEHTTP DELETE Method.
Patch
PATCHHTTP PATCH Method.
Options
OPTIONSHTTP OPTIONS Method.
HTTP_METHOD_UNSPECIFIED
HTTP_METHOD_UNSPECIFIEDHTTP method not specified.
POST
POSTHTTP POST Method.
GET
GETHTTP GET Method.
HEAD
HEADHTTP HEAD Method.
PUT
PUTHTTP PUT Method.
DELETE
DELETEHTTP DELETE Method.
PATCH
PATCHHTTP PATCH Method.
OPTIONS
OPTIONSHTTP OPTIONS Method.
"HTTP_METHOD_UNSPECIFIED"
HTTP_METHOD_UNSPECIFIEDHTTP method not specified.
"POST"
POSTHTTP POST Method.
"GET"
GETHTTP GET Method.
"HEAD"
HEADHTTP HEAD Method.
"PUT"
PUTHTTP PUT Method.
"DELETE"
DELETEHTTP DELETE Method.
"PATCH"
PATCHHTTP PATCH Method.
"OPTIONS"
OPTIONSHTTP OPTIONS Method.

GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse
, GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponseArgs

AllowedCaCerts This property is required. List<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'")
HttpMethod This property is required. string
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
ParameterMapping This property is required. Dictionary<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
Password This property is required. string
The password for HTTP Basic authentication.
RequestBody This property is required. string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
RequestHeaders This property is required. Dictionary<string, string>
The HTTP request headers to send together with webhook requests.
Uri This property is required. string
The webhook URI for receiving POST requests. It must use https protocol.
Username This property is required. string
The user name for HTTP Basic authentication.
WebhookType This property is required. string
Optional. Type of the webhook.
AllowedCaCerts This property is required. []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'")
HttpMethod This property is required. string
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
ParameterMapping This property is required. 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
Password This property is required. string
The password for HTTP Basic authentication.
RequestBody This property is required. string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
RequestHeaders This property is required. map[string]string
The HTTP request headers to send together with webhook requests.
Uri This property is required. string
The webhook URI for receiving POST requests. It must use https protocol.
Username This property is required. string
The user name for HTTP Basic authentication.
WebhookType This property is required. string
Optional. Type of the webhook.
allowedCaCerts This property is required. List<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'")
httpMethod This property is required. String
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameterMapping This property is required. 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
password This property is required. String
The password for HTTP Basic authentication.
requestBody This property is required. String
Optional. Defines a custom JSON object as request body to send to flexible webhook.
requestHeaders This property is required. Map<String,String>
The HTTP request headers to send together with webhook requests.
uri This property is required. String
The webhook URI for receiving POST requests. It must use https protocol.
username This property is required. String
The user name for HTTP Basic authentication.
webhookType This property is required. String
Optional. Type of the webhook.
allowedCaCerts This property is required. 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'")
httpMethod This property is required. string
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameterMapping This property is required. {[key: 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
password This property is required. string
The password for HTTP Basic authentication.
requestBody This property is required. string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
requestHeaders This property is required. {[key: string]: string}
The HTTP request headers to send together with webhook requests.
uri This property is required. string
The webhook URI for receiving POST requests. It must use https protocol.
username This property is required. string
The user name for HTTP Basic authentication.
webhookType This property is required. string
Optional. Type of the webhook.
allowed_ca_certs This property is required. Sequence[str]
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'")
http_method This property is required. str
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameter_mapping This property is required. Mapping[str, str]
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
password This property is required. str
The password for HTTP Basic authentication.
request_body This property is required. str
Optional. Defines a custom JSON object as request body to send to flexible webhook.
request_headers This property is required. Mapping[str, str]
The HTTP request headers to send together with webhook requests.
uri This property is required. str
The webhook URI for receiving POST requests. It must use https protocol.
username This property is required. str
The user name for HTTP Basic authentication.
webhook_type This property is required. str
Optional. Type of the webhook.
allowedCaCerts This property is required. List<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'")
httpMethod This property is required. String
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
parameterMapping This property is required. Map<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
password This property is required. String
The password for HTTP Basic authentication.
requestBody This property is required. String
Optional. Defines a custom JSON object as request body to send to flexible webhook.
requestHeaders This property is required. Map<String>
The HTTP request headers to send together with webhook requests.
uri This property is required. String
The webhook URI for receiving POST requests. It must use https protocol.
username This property is required. String
The user name for HTTP Basic authentication.
webhookType This property is required. String
Optional. Type of the webhook.

GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookType
, GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookTypeArgs

WebhookTypeUnspecified
WEBHOOK_TYPE_UNSPECIFIEDDefault value. This value is unused.
Standard
STANDARDRepresents a standard webhook.
Flexible
FLEXIBLERepresents a flexible webhook.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookTypeWebhookTypeUnspecified
WEBHOOK_TYPE_UNSPECIFIEDDefault value. This value is unused.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookTypeStandard
STANDARDRepresents a standard webhook.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceWebhookTypeFlexible
FLEXIBLERepresents a flexible webhook.
WebhookTypeUnspecified
WEBHOOK_TYPE_UNSPECIFIEDDefault value. This value is unused.
Standard
STANDARDRepresents a standard webhook.
Flexible
FLEXIBLERepresents a flexible webhook.
WebhookTypeUnspecified
WEBHOOK_TYPE_UNSPECIFIEDDefault value. This value is unused.
Standard
STANDARDRepresents a standard webhook.
Flexible
FLEXIBLERepresents a flexible webhook.
WEBHOOK_TYPE_UNSPECIFIED
WEBHOOK_TYPE_UNSPECIFIEDDefault value. This value is unused.
STANDARD
STANDARDRepresents a standard webhook.
FLEXIBLE
FLEXIBLERepresents a flexible webhook.
"WEBHOOK_TYPE_UNSPECIFIED"
WEBHOOK_TYPE_UNSPECIFIEDDefault value. This value is unused.
"STANDARD"
STANDARDRepresents a standard webhook.
"FLEXIBLE"
FLEXIBLERepresents a flexible webhook.

GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
, GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigArgs

Service This property is required. string
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.
GenericWebService Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebService
Generic Service configuration of this webhook.
Service This property is required. string
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.
GenericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService
Generic Service configuration of this webhook.
service This property is required. String
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.
genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService
Generic Service configuration of this webhook.
service This property is required. string
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.
genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService
Generic Service configuration of this webhook.
service This property is required. str
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.
generic_web_service GoogleCloudDialogflowCxV3WebhookGenericWebService
Generic Service configuration of this webhook.
service This property is required. String
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.
genericWebService Property Map
Generic Service configuration of this webhook.

GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse
, GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponseArgs

GenericWebService This property is required. Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse
Generic Service configuration of this webhook.
Service This property is required. string
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.
GenericWebService This property is required. GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse
Generic Service configuration of this webhook.
Service This property is required. string
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.
genericWebService This property is required. GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse
Generic Service configuration of this webhook.
service This property is required. String
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.
genericWebService This property is required. GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse
Generic Service configuration of this webhook.
service This property is required. string
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.
generic_web_service This property is required. GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse
Generic Service configuration of this webhook.
service This property is required. str
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.
genericWebService This property is required. Property Map
Generic Service configuration of this webhook.
service This property is required. String
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.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native