GoogleCloudDialogflowCxV3WebhookGenericWebService

import type { GoogleCloudDialogflowCxV3WebhookGenericWebService } from "https://googleapis.deno.dev/v1/dialogflow:v3.ts";

Represents configuration for a generic web service.

interface GoogleCloudDialogflowCxV3WebhookGenericWebService {

allowedCaCerts?: Uint8Array[];

httpMethod?:

| "HTTP_METHOD_UNSPECIFIED"

| "POST"

| "GET"

| "HEAD"

| "PUT"

| "DELETE"

| "PATCH"

| "OPTIONS";

oauthConfig?: GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig;

parameterMapping?: {

[key: string]: string;

};

password?: string;

requestBody?: string;

requestHeaders?: {

[key: string]: string;

};

serviceAgentAuth?:

| "SERVICE_AGENT_AUTH_UNSPECIFIED"

| "NONE"

| "ID_TOKEN"

| "ACCESS_TOKEN";

uri?: string;

username?: string;

webhookType?: "WEBHOOK_TYPE_UNSPECIFIED" | "STANDARD" | "FLEXIBLE";

}

§Properties

allowedCaCerts?: Uint8Array[]

[src]

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

[src]

Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.

oauthConfig?: GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig

[src]

Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.

parameterMapping?: {

[key: string]: string;

}

[src]

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

[src]

The password for HTTP Basic authentication.

requestBody?: string

[src]

Optional. Defines a custom JSON object as request body to send to flexible webhook.

requestHeaders?: {

[key: string]: string;

}

[src]

The HTTP request headers to send together with webhook requests.

serviceAgentAuth?: "SERVICE_AGENT_AUTH_UNSPECIFIED" | "NONE" | "ID_TOKEN" | "ACCESS_TOKEN"

[src]

Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.

uri?: string

[src]

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

username?: string

[src]

The user name for HTTP Basic authentication.

webhookType?: "WEBHOOK_TYPE_UNSPECIFIED" | "STANDARD" | "FLEXIBLE"

[src]

Optional. Type of the webhook.