1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3beta1
  6. getWebhook

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

google-native.dialogflow/v3beta1.getWebhook

Explore with Pulumi AI

google-native logo

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

    Retrieves the specified webhook.

    Using getWebhook

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebhook(args: GetWebhookArgs, opts?: InvokeOptions): Promise<GetWebhookResult>
    function getWebhookOutput(args: GetWebhookOutputArgs, opts?: InvokeOptions): Output<GetWebhookResult>
    def get_webhook(agent_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    webhook_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWebhookResult
    def get_webhook_output(agent_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    webhook_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWebhookResult]
    func LookupWebhook(ctx *Context, args *LookupWebhookArgs, opts ...InvokeOption) (*LookupWebhookResult, error)
    func LookupWebhookOutput(ctx *Context, args *LookupWebhookOutputArgs, opts ...InvokeOption) LookupWebhookResultOutput

    > Note: This function is named LookupWebhook in the Go SDK.

    public static class GetWebhook 
    {
        public static Task<GetWebhookResult> InvokeAsync(GetWebhookArgs args, InvokeOptions? opts = null)
        public static Output<GetWebhookResult> Invoke(GetWebhookInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:dialogflow/v3beta1:getWebhook
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AgentId string
    Location string
    WebhookId string
    Project string
    AgentId string
    Location string
    WebhookId string
    Project string
    agentId String
    location String
    webhookId String
    project String
    agentId string
    location string
    webhookId string
    project string
    agentId String
    location String
    webhookId String
    project String

    getWebhook Result

    The following output properties are available:

    Disabled bool

    Indicates whether the webhook is disabled.

    DisplayName string

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

    GenericWebService Pulumi.GoogleNative.Dialogflow.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    Configuration for a generic web service.

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

    ServiceDirectory Pulumi.GoogleNative.Dialogflow.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfigResponse

    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.

    Disabled bool

    Indicates whether the webhook is disabled.

    DisplayName string

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

    GenericWebService GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    Configuration for a generic web service.

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

    ServiceDirectory GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfigResponse

    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.

    disabled Boolean

    Indicates whether the webhook is disabled.

    displayName String

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

    genericWebService GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    Configuration for a generic web service.

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

    serviceDirectory GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfigResponse

    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.

    disabled boolean

    Indicates whether the webhook is disabled.

    displayName string

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

    genericWebService GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    Configuration for a generic web service.

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

    serviceDirectory GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfigResponse

    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.

    disabled bool

    Indicates whether the webhook is disabled.

    display_name str

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

    generic_web_service GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    Configuration for a generic web service.

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

    service_directory GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfigResponse

    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.

    disabled Boolean

    Indicates whether the webhook is disabled.

    displayName String

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

    genericWebService Property Map

    Configuration for a generic web service.

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

    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.

    Supporting Types

    GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    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 string

    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.

    Uri string

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

    Username string

    The user name for HTTP Basic authentication.

    WebhookType string

    Optional. Type of the webhook.

    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 string

    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.

    Uri string

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

    Username string

    The user name for HTTP Basic authentication.

    WebhookType string

    Optional. Type of the webhook.

    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 String

    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.

    uri String

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

    username String

    The user name for HTTP Basic authentication.

    webhookType String

    Optional. Type of the webhook.

    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 string

    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.

    uri string

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

    username string

    The user name for HTTP Basic authentication.

    webhookType string

    Optional. Type of the webhook.

    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 str

    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.

    uri str

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

    username str

    The user name for HTTP Basic authentication.

    webhook_type str

    Optional. Type of the webhook.

    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 String

    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.

    uri String

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

    username String

    The user name for HTTP Basic authentication.

    webhookType String

    Optional. Type of the webhook.

    GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfigResponse

    GenericWebService Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    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 GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    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 GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    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 GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    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 GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceResponse

    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
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    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