Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

Webhook

Creates a webhook in the specified agent.

Create Webhook Resource

new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            agent_id: Optional[str] = None,
            disabled: Optional[bool] = None,
            display_name: Optional[str] = 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)
@overload
def Webhook(resource_name: str,
            args: WebhookArgs,
            opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The Webhook resource accepts the following input properties:

AgentId string
DisplayName 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.GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs

Configuration for a generic web service.

Location 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 string
ServiceDirectory Pulumi.GoogleNative.Dialogflow.V3.Inputs.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 string
DisplayName 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 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 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 String
displayName String

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

disabled Boolean

Indicates whether the webhook is disabled.

genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs

Configuration for a generic web service.

location 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 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 string
displayName string

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

disabled boolean

Indicates whether the webhook is disabled.

genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceArgs

Configuration for a generic web service.

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

agent_id str
display_name 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 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 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 String
displayName 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 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 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

Uri 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'")

Password string

The password for HTTP Basic authentication.

RequestHeaders Dictionary<string, string>

The HTTP request headers to send together with webhook requests.

Username string

The user name for HTTP Basic authentication.

Uri 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'")

Password string

The password for HTTP Basic authentication.

RequestHeaders map[string]string

The HTTP request headers to send together with webhook requests.

Username string

The user name for HTTP Basic authentication.

uri 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'")

password String

The password for HTTP Basic authentication.

requestHeaders Map<String,String>

The HTTP request headers to send together with webhook requests.

username String

The user name for HTTP Basic authentication.

uri 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'")

password string

The password for HTTP Basic authentication.

requestHeaders {[key: string]: string}

The HTTP request headers to send together with webhook requests.

username string

The user name for HTTP Basic authentication.

uri 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'")

password str

The password for HTTP Basic authentication.

request_headers Mapping[str, str]

The HTTP request headers to send together with webhook requests.

username str

The user name for HTTP Basic authentication.

uri 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'")

password String

The password for HTTP Basic authentication.

requestHeaders Map<String>

The HTTP request headers to send together with webhook requests.

username String

The user name for HTTP Basic authentication.

GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

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'")

Password string

The password for HTTP Basic authentication.

RequestHeaders Dictionary<string, string>

The HTTP request headers to send together with webhook requests.

Uri string

The webhook URI for receiving POST requests. It must use https protocol.

Username string

The user name for HTTP Basic authentication.

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'")

Password string

The password for HTTP Basic authentication.

RequestHeaders map[string]string

The HTTP request headers to send together with webhook requests.

Uri string

The webhook URI for receiving POST requests. It must use https protocol.

Username string

The user name for HTTP Basic authentication.

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'")

password String

The password for HTTP Basic authentication.

requestHeaders Map<String,String>

The HTTP request headers to send together with webhook requests.

uri String

The webhook URI for receiving POST requests. It must use https protocol.

username String

The user name for HTTP Basic authentication.

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'")

password string

The password for HTTP Basic authentication.

requestHeaders {[key: string]: string}

The HTTP request headers to send together with webhook requests.

uri string

The webhook URI for receiving POST requests. It must use https protocol.

username string

The user name for HTTP Basic authentication.

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'")

password str

The password for HTTP Basic authentication.

request_headers Mapping[str, str]

The HTTP request headers to send together with webhook requests.

uri str

The webhook URI for receiving POST requests. It must use https protocol.

username str

The user name for HTTP Basic authentication.

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'")

password String

The password for HTTP Basic authentication.

requestHeaders Map<String>

The HTTP request headers to send together with webhook requests.

uri String

The webhook URI for receiving POST requests. It must use https protocol.

username String

The user name for HTTP Basic authentication.

GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig

Service 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 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 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 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 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 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

GenericWebService Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

Service 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 GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

Service 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 GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

service 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 GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

service 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 GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

service 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 Property Map

Generic Service configuration of this webhook.

service 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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0