1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. CxWebhook
Google Cloud Classic v7.30.2 published on Wednesday, Jul 10, 2024 by Pulumi

gcp.diagflow.CxWebhook

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.30.2 published on Wednesday, Jul 10, 2024 by Pulumi

    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.

    To get more information about Webhook, see:

    Example Usage

    Dialogflowcx Webhook Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const agent = new gcp.diagflow.CxAgent("agent", {
        displayName: "dialogflowcx-agent",
        location: "global",
        defaultLanguageCode: "en",
        supportedLanguageCodes: [
            "it",
            "de",
            "es",
        ],
        timeZone: "America/New_York",
        description: "Example description.",
        avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        enableStackdriverLogging: true,
        enableSpellCorrection: true,
        speechToTextSettings: {
            enableSpeechAdaptation: true,
        },
    });
    const basicWebhook = new gcp.diagflow.CxWebhook("basic_webhook", {
        parent: agent.id,
        displayName: "MyFlow",
        genericWebService: {
            uri: "https://example.com",
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    agent = gcp.diagflow.CxAgent("agent",
        display_name="dialogflowcx-agent",
        location="global",
        default_language_code="en",
        supported_language_codes=[
            "it",
            "de",
            "es",
        ],
        time_zone="America/New_York",
        description="Example description.",
        avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        enable_stackdriver_logging=True,
        enable_spell_correction=True,
        speech_to_text_settings={
            "enableSpeechAdaptation": True,
        })
    basic_webhook = gcp.diagflow.CxWebhook("basic_webhook",
        parent=agent.id,
        display_name="MyFlow",
        generic_web_service={
            "uri": "https://example.com",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		agent, err := diagflow.NewCxAgent(ctx, "agent", &diagflow.CxAgentArgs{
    			DisplayName:         pulumi.String("dialogflowcx-agent"),
    			Location:            pulumi.String("global"),
    			DefaultLanguageCode: pulumi.String("en"),
    			SupportedLanguageCodes: pulumi.StringArray{
    				pulumi.String("it"),
    				pulumi.String("de"),
    				pulumi.String("es"),
    			},
    			TimeZone:                 pulumi.String("America/New_York"),
    			Description:              pulumi.String("Example description."),
    			AvatarUri:                pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
    			EnableStackdriverLogging: pulumi.Bool(true),
    			EnableSpellCorrection:    pulumi.Bool(true),
    			SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
    				EnableSpeechAdaptation: pulumi.Bool(true),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = diagflow.NewCxWebhook(ctx, "basic_webhook", &diagflow.CxWebhookArgs{
    			Parent:      agent.ID(),
    			DisplayName: pulumi.String("MyFlow"),
    			GenericWebService: &diagflow.CxWebhookGenericWebServiceArgs{
    				Uri: pulumi.String("https://example.com"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var agent = new Gcp.Diagflow.CxAgent("agent", new()
        {
            DisplayName = "dialogflowcx-agent",
            Location = "global",
            DefaultLanguageCode = "en",
            SupportedLanguageCodes = new[]
            {
                "it",
                "de",
                "es",
            },
            TimeZone = "America/New_York",
            Description = "Example description.",
            AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
            EnableStackdriverLogging = true,
            EnableSpellCorrection = true,
            SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
            {
                EnableSpeechAdaptation = true,
            },
        });
    
        var basicWebhook = new Gcp.Diagflow.CxWebhook("basic_webhook", new()
        {
            Parent = agent.Id,
            DisplayName = "MyFlow",
            GenericWebService = new Gcp.Diagflow.Inputs.CxWebhookGenericWebServiceArgs
            {
                Uri = "https://example.com",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.diagflow.CxAgent;
    import com.pulumi.gcp.diagflow.CxAgentArgs;
    import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
    import com.pulumi.gcp.diagflow.CxWebhook;
    import com.pulumi.gcp.diagflow.CxWebhookArgs;
    import com.pulumi.gcp.diagflow.inputs.CxWebhookGenericWebServiceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var agent = new CxAgent("agent", CxAgentArgs.builder()
                .displayName("dialogflowcx-agent")
                .location("global")
                .defaultLanguageCode("en")
                .supportedLanguageCodes(            
                    "it",
                    "de",
                    "es")
                .timeZone("America/New_York")
                .description("Example description.")
                .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
                .enableStackdriverLogging(true)
                .enableSpellCorrection(true)
                .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
                    .enableSpeechAdaptation(true)
                    .build())
                .build());
    
            var basicWebhook = new CxWebhook("basicWebhook", CxWebhookArgs.builder()
                .parent(agent.id())
                .displayName("MyFlow")
                .genericWebService(CxWebhookGenericWebServiceArgs.builder()
                    .uri("https://example.com")
                    .build())
                .build());
    
        }
    }
    
    resources:
      agent:
        type: gcp:diagflow:CxAgent
        properties:
          displayName: dialogflowcx-agent
          location: global
          defaultLanguageCode: en
          supportedLanguageCodes:
            - it
            - de
            - es
          timeZone: America/New_York
          description: Example description.
          avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
          enableStackdriverLogging: true
          enableSpellCorrection: true
          speechToTextSettings:
            enableSpeechAdaptation: true
      basicWebhook:
        type: gcp:diagflow:CxWebhook
        name: basic_webhook
        properties:
          parent: ${agent.id}
          displayName: MyFlow
          genericWebService:
            uri: https://example.com
    

    Create CxWebhook Resource

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

    Constructor syntax

    new CxWebhook(name: string, args: CxWebhookArgs, opts?: CustomResourceOptions);
    @overload
    def CxWebhook(resource_name: str,
                  args: CxWebhookArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def CxWebhook(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  disabled: Optional[bool] = None,
                  enable_spell_correction: Optional[bool] = None,
                  enable_stackdriver_logging: Optional[bool] = None,
                  generic_web_service: Optional[CxWebhookGenericWebServiceArgs] = None,
                  parent: Optional[str] = None,
                  security_settings: Optional[str] = None,
                  service_directory: Optional[CxWebhookServiceDirectoryArgs] = None,
                  timeout: Optional[str] = None)
    func NewCxWebhook(ctx *Context, name string, args CxWebhookArgs, opts ...ResourceOption) (*CxWebhook, error)
    public CxWebhook(string name, CxWebhookArgs args, CustomResourceOptions? opts = null)
    public CxWebhook(String name, CxWebhookArgs args)
    public CxWebhook(String name, CxWebhookArgs args, CustomResourceOptions options)
    
    type: gcp:diagflow:CxWebhook
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CxWebhookArgs
    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 CxWebhookArgs
    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 CxWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CxWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CxWebhookArgs
    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 cxWebhookResource = new Gcp.Diagflow.CxWebhook("cxWebhookResource", new()
    {
        DisplayName = "string",
        Disabled = false,
        EnableSpellCorrection = false,
        EnableStackdriverLogging = false,
        GenericWebService = new Gcp.Diagflow.Inputs.CxWebhookGenericWebServiceArgs
        {
            Uri = "string",
            AllowedCaCerts = new[]
            {
                "string",
            },
            RequestHeaders = 
            {
                { "string", "string" },
            },
        },
        Parent = "string",
        SecuritySettings = "string",
        ServiceDirectory = new Gcp.Diagflow.Inputs.CxWebhookServiceDirectoryArgs
        {
            GenericWebService = new Gcp.Diagflow.Inputs.CxWebhookServiceDirectoryGenericWebServiceArgs
            {
                Uri = "string",
                AllowedCaCerts = new[]
                {
                    "string",
                },
                RequestHeaders = 
                {
                    { "string", "string" },
                },
            },
            Service = "string",
        },
        Timeout = "string",
    });
    
    example, err := diagflow.NewCxWebhook(ctx, "cxWebhookResource", &diagflow.CxWebhookArgs{
    	DisplayName:              pulumi.String("string"),
    	Disabled:                 pulumi.Bool(false),
    	EnableSpellCorrection:    pulumi.Bool(false),
    	EnableStackdriverLogging: pulumi.Bool(false),
    	GenericWebService: &diagflow.CxWebhookGenericWebServiceArgs{
    		Uri: pulumi.String("string"),
    		AllowedCaCerts: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		RequestHeaders: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    	},
    	Parent:           pulumi.String("string"),
    	SecuritySettings: pulumi.String("string"),
    	ServiceDirectory: &diagflow.CxWebhookServiceDirectoryArgs{
    		GenericWebService: &diagflow.CxWebhookServiceDirectoryGenericWebServiceArgs{
    			Uri: pulumi.String("string"),
    			AllowedCaCerts: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			RequestHeaders: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    		},
    		Service: pulumi.String("string"),
    	},
    	Timeout: pulumi.String("string"),
    })
    
    var cxWebhookResource = new CxWebhook("cxWebhookResource", CxWebhookArgs.builder()
        .displayName("string")
        .disabled(false)
        .enableSpellCorrection(false)
        .enableStackdriverLogging(false)
        .genericWebService(CxWebhookGenericWebServiceArgs.builder()
            .uri("string")
            .allowedCaCerts("string")
            .requestHeaders(Map.of("string", "string"))
            .build())
        .parent("string")
        .securitySettings("string")
        .serviceDirectory(CxWebhookServiceDirectoryArgs.builder()
            .genericWebService(CxWebhookServiceDirectoryGenericWebServiceArgs.builder()
                .uri("string")
                .allowedCaCerts("string")
                .requestHeaders(Map.of("string", "string"))
                .build())
            .service("string")
            .build())
        .timeout("string")
        .build());
    
    cx_webhook_resource = gcp.diagflow.CxWebhook("cxWebhookResource",
        display_name="string",
        disabled=False,
        enable_spell_correction=False,
        enable_stackdriver_logging=False,
        generic_web_service={
            "uri": "string",
            "allowedCaCerts": ["string"],
            "requestHeaders": {
                "string": "string",
            },
        },
        parent="string",
        security_settings="string",
        service_directory={
            "genericWebService": {
                "uri": "string",
                "allowedCaCerts": ["string"],
                "requestHeaders": {
                    "string": "string",
                },
            },
            "service": "string",
        },
        timeout="string")
    
    const cxWebhookResource = new gcp.diagflow.CxWebhook("cxWebhookResource", {
        displayName: "string",
        disabled: false,
        enableSpellCorrection: false,
        enableStackdriverLogging: false,
        genericWebService: {
            uri: "string",
            allowedCaCerts: ["string"],
            requestHeaders: {
                string: "string",
            },
        },
        parent: "string",
        securitySettings: "string",
        serviceDirectory: {
            genericWebService: {
                uri: "string",
                allowedCaCerts: ["string"],
                requestHeaders: {
                    string: "string",
                },
            },
            service: "string",
        },
        timeout: "string",
    });
    
    type: gcp:diagflow:CxWebhook
    properties:
        disabled: false
        displayName: string
        enableSpellCorrection: false
        enableStackdriverLogging: false
        genericWebService:
            allowedCaCerts:
                - string
            requestHeaders:
                string: string
            uri: string
        parent: string
        securitySettings: string
        serviceDirectory:
            genericWebService:
                allowedCaCerts:
                    - string
                requestHeaders:
                    string: string
                uri: string
            service: string
        timeout: string
    

    CxWebhook 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 CxWebhook resource accepts the following input properties:

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


    Disabled bool
    Indicates whether the webhook is disabled.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    GenericWebService CxWebhookGenericWebService
    Configuration for a generic web service. Structure is documented below.
    Parent string
    The agent to create a webhook for. Format: projects//locations//agents/.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    ServiceDirectory CxWebhookServiceDirectory
    Configuration for a Service Directory service. Structure is documented below.
    Timeout string
    Webhook execution timeout.
    DisplayName string
    The human-readable name of the webhook, unique within the agent.


    Disabled bool
    Indicates whether the webhook is disabled.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    GenericWebService CxWebhookGenericWebServiceArgs
    Configuration for a generic web service. Structure is documented below.
    Parent string
    The agent to create a webhook for. Format: projects//locations//agents/.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    ServiceDirectory CxWebhookServiceDirectoryArgs
    Configuration for a Service Directory service. Structure is documented below.
    Timeout string
    Webhook execution timeout.
    displayName String
    The human-readable name of the webhook, unique within the agent.


    disabled Boolean
    Indicates whether the webhook is disabled.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    genericWebService CxWebhookGenericWebService
    Configuration for a generic web service. Structure is documented below.
    parent String
    The agent to create a webhook for. Format: projects//locations//agents/.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    serviceDirectory CxWebhookServiceDirectory
    Configuration for a Service Directory service. Structure is documented below.
    timeout String
    Webhook execution timeout.
    displayName string
    The human-readable name of the webhook, unique within the agent.


    disabled boolean
    Indicates whether the webhook is disabled.
    enableSpellCorrection boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging boolean
    Determines whether this agent should log conversation queries.
    genericWebService CxWebhookGenericWebService
    Configuration for a generic web service. Structure is documented below.
    parent string
    The agent to create a webhook for. Format: projects//locations//agents/.
    securitySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    serviceDirectory CxWebhookServiceDirectory
    Configuration for a Service Directory service. Structure is documented below.
    timeout string
    Webhook execution timeout.
    display_name str
    The human-readable name of the webhook, unique within the agent.


    disabled bool
    Indicates whether the webhook is disabled.
    enable_spell_correction bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    enable_stackdriver_logging bool
    Determines whether this agent should log conversation queries.
    generic_web_service CxWebhookGenericWebServiceArgs
    Configuration for a generic web service. Structure is documented below.
    parent str
    The agent to create a webhook for. Format: projects//locations//agents/.
    security_settings str
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    service_directory CxWebhookServiceDirectoryArgs
    Configuration for a Service Directory service. Structure is documented below.
    timeout str
    Webhook execution timeout.
    displayName String
    The human-readable name of the webhook, unique within the agent.


    disabled Boolean
    Indicates whether the webhook is disabled.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    genericWebService Property Map
    Configuration for a generic web service. Structure is documented below.
    parent String
    The agent to create a webhook for. Format: projects//locations//agents/.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    serviceDirectory Property Map
    Configuration for a Service Directory service. Structure is documented below.
    timeout String
    Webhook execution timeout.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    startFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    start_flow str
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

    Look up Existing CxWebhook Resource

    Get an existing CxWebhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CxWebhookState, opts?: CustomResourceOptions): CxWebhook
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            disabled: Optional[bool] = None,
            display_name: Optional[str] = None,
            enable_spell_correction: Optional[bool] = None,
            enable_stackdriver_logging: Optional[bool] = None,
            generic_web_service: Optional[CxWebhookGenericWebServiceArgs] = None,
            name: Optional[str] = None,
            parent: Optional[str] = None,
            security_settings: Optional[str] = None,
            service_directory: Optional[CxWebhookServiceDirectoryArgs] = None,
            start_flow: Optional[str] = None,
            timeout: Optional[str] = None) -> CxWebhook
    func GetCxWebhook(ctx *Context, name string, id IDInput, state *CxWebhookState, opts ...ResourceOption) (*CxWebhook, error)
    public static CxWebhook Get(string name, Input<string> id, CxWebhookState? state, CustomResourceOptions? opts = null)
    public static CxWebhook get(String name, Output<String> id, CxWebhookState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Disabled bool
    Indicates whether the webhook is disabled.
    DisplayName string
    The human-readable name of the webhook, unique within the agent.


    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    GenericWebService CxWebhookGenericWebService
    Configuration for a generic web service. Structure is documented below.
    Name string
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    Parent string
    The agent to create a webhook for. Format: projects//locations//agents/.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    ServiceDirectory CxWebhookServiceDirectory
    Configuration for a Service Directory service. Structure is documented below.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    Timeout string
    Webhook execution timeout.
    Disabled bool
    Indicates whether the webhook is disabled.
    DisplayName string
    The human-readable name of the webhook, unique within the agent.


    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    GenericWebService CxWebhookGenericWebServiceArgs
    Configuration for a generic web service. Structure is documented below.
    Name string
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    Parent string
    The agent to create a webhook for. Format: projects//locations//agents/.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    ServiceDirectory CxWebhookServiceDirectoryArgs
    Configuration for a Service Directory service. Structure is documented below.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    Timeout string
    Webhook execution timeout.
    disabled Boolean
    Indicates whether the webhook is disabled.
    displayName String
    The human-readable name of the webhook, unique within the agent.


    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    genericWebService CxWebhookGenericWebService
    Configuration for a generic web service. Structure is documented below.
    name String
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    parent String
    The agent to create a webhook for. Format: projects//locations//agents/.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    serviceDirectory CxWebhookServiceDirectory
    Configuration for a Service Directory service. Structure is documented below.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    timeout String
    Webhook execution timeout.
    disabled boolean
    Indicates whether the webhook is disabled.
    displayName string
    The human-readable name of the webhook, unique within the agent.


    enableSpellCorrection boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging boolean
    Determines whether this agent should log conversation queries.
    genericWebService CxWebhookGenericWebService
    Configuration for a generic web service. Structure is documented below.
    name string
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    parent string
    The agent to create a webhook for. Format: projects//locations//agents/.
    securitySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    serviceDirectory CxWebhookServiceDirectory
    Configuration for a Service Directory service. Structure is documented below.
    startFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    timeout string
    Webhook execution timeout.
    disabled bool
    Indicates whether the webhook is disabled.
    display_name str
    The human-readable name of the webhook, unique within the agent.


    enable_spell_correction bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    enable_stackdriver_logging bool
    Determines whether this agent should log conversation queries.
    generic_web_service CxWebhookGenericWebServiceArgs
    Configuration for a generic web service. Structure is documented below.
    name str
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    parent str
    The agent to create a webhook for. Format: projects//locations//agents/.
    security_settings str
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    service_directory CxWebhookServiceDirectoryArgs
    Configuration for a Service Directory service. Structure is documented below.
    start_flow str
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    timeout str
    Webhook execution timeout.
    disabled Boolean
    Indicates whether the webhook is disabled.
    displayName String
    The human-readable name of the webhook, unique within the agent.


    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    genericWebService Property Map
    Configuration for a generic web service. Structure is documented below.
    name String
    The unique identifier of the webhook. Format: projects//locations//agents//webhooks/.
    parent String
    The agent to create a webhook for. Format: projects//locations//agents/.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    serviceDirectory Property Map
    Configuration for a Service Directory service. Structure is documented below.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    timeout String
    Webhook execution timeout.

    Supporting Types

    CxWebhookGenericWebService, CxWebhookGenericWebServiceArgs

    Uri string
    Whether to use speech adaptation for speech recognition.
    AllowedCaCerts List<string>
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    RequestHeaders Dictionary<string, string>
    The HTTP request headers to send together with webhook requests.
    Uri string
    Whether to use speech adaptation for speech recognition.
    AllowedCaCerts []string
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    RequestHeaders map[string]string
    The HTTP request headers to send together with webhook requests.
    uri String
    Whether to use speech adaptation for speech recognition.
    allowedCaCerts List<String>
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    requestHeaders Map<String,String>
    The HTTP request headers to send together with webhook requests.
    uri string
    Whether to use speech adaptation for speech recognition.
    allowedCaCerts string[]
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    requestHeaders {[key: string]: string}
    The HTTP request headers to send together with webhook requests.
    uri str
    Whether to use speech adaptation for speech recognition.
    allowed_ca_certs Sequence[str]
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    request_headers Mapping[str, str]
    The HTTP request headers to send together with webhook requests.
    uri String
    Whether to use speech adaptation for speech recognition.
    allowedCaCerts List<String>
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    requestHeaders Map<String>
    The HTTP request headers to send together with webhook requests.

    CxWebhookServiceDirectory, CxWebhookServiceDirectoryArgs

    GenericWebService CxWebhookServiceDirectoryGenericWebService
    The name of Service Directory service. Structure is documented below.
    Service string
    The name of Service Directory service.
    GenericWebService CxWebhookServiceDirectoryGenericWebService
    The name of Service Directory service. Structure is documented below.
    Service string
    The name of Service Directory service.
    genericWebService CxWebhookServiceDirectoryGenericWebService
    The name of Service Directory service. Structure is documented below.
    service String
    The name of Service Directory service.
    genericWebService CxWebhookServiceDirectoryGenericWebService
    The name of Service Directory service. Structure is documented below.
    service string
    The name of Service Directory service.
    generic_web_service CxWebhookServiceDirectoryGenericWebService
    The name of Service Directory service. Structure is documented below.
    service str
    The name of Service Directory service.
    genericWebService Property Map
    The name of Service Directory service. Structure is documented below.
    service String
    The name of Service Directory service.

    CxWebhookServiceDirectoryGenericWebService, CxWebhookServiceDirectoryGenericWebServiceArgs

    Uri string
    Whether to use speech adaptation for speech recognition.
    AllowedCaCerts List<string>
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    RequestHeaders Dictionary<string, string>
    The HTTP request headers to send together with webhook requests.
    Uri string
    Whether to use speech adaptation for speech recognition.
    AllowedCaCerts []string
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    RequestHeaders map[string]string
    The HTTP request headers to send together with webhook requests.
    uri String
    Whether to use speech adaptation for speech recognition.
    allowedCaCerts List<String>
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    requestHeaders Map<String,String>
    The HTTP request headers to send together with webhook requests.
    uri string
    Whether to use speech adaptation for speech recognition.
    allowedCaCerts string[]
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    requestHeaders {[key: string]: string}
    The HTTP request headers to send together with webhook requests.
    uri str
    Whether to use speech adaptation for speech recognition.
    allowed_ca_certs Sequence[str]
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    request_headers Mapping[str, str]
    The HTTP request headers to send together with webhook requests.
    uri String
    Whether to use speech adaptation for speech recognition.
    allowedCaCerts List<String>
    Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification.
    requestHeaders Map<String>
    The HTTP request headers to send together with webhook requests.

    Import

    Webhook can be imported using any of these accepted formats:

    • {{parent}}/webhooks/{{name}}

    • {{parent}}/{{name}}

    When using the pulumi import command, Webhook can be imported using one of the formats above. For example:

    $ pulumi import gcp:diagflow/cxWebhook:CxWebhook default {{parent}}/webhooks/{{name}}
    
    $ pulumi import gcp:diagflow/cxWebhook:CxWebhook default {{parent}}/{{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.30.2 published on Wednesday, Jul 10, 2024 by Pulumi