Fulfillment

By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.

For more information, see the fulfillment guide.

JSON representation
{
  "name": string,
  "displayName": string,
  "enabled": boolean,
  "features": [
    {
      object (Feature)
    }
  ],
  "genericWebService": {
    object (GenericWebService)
  }
}
Fields
name

string

Required. The unique identifier of the fulfillment. Supported formats: - projects/<Project ID>/agent/fulfillment - projects/<Project ID>/locations/<Location ID>/agent/fulfillment

displayName

string

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

enabled

boolean

Whether fulfillment is enabled.

features[]

object (Feature)

The field defines whether the fulfillment is enabled for certain features.

genericWebService

object (GenericWebService)

Configuration for a generic web service.

GenericWebService

Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.

JSON representation
{
  "uri": string,
  "username": string,
  "password": string,
  "requestHeaders": {
    string: string,
    ...
  },
  "isCloudFunction": boolean
}
Fields
uri

string

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

username

string

The user name for HTTP Basic authentication.

password

string

The password for HTTP Basic authentication.

requestHeaders

map (key: string, value: string)

The HTTP request headers to send together with fulfillment requests.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

isCloudFunction

boolean

Indicates if generic web service is created through Cloud Functions integration. Defaults to false.

Feature

Whether fulfillment is enabled for the specific feature.

JSON representation
{
  "type": enum (Type)
}
Fields
type

enum (Type)

The type of the feature that enabled for fulfillment.

Type

The type of the feature.

Enums
TYPE_UNSPECIFIED Feature type not specified.
SMALLTALK Fulfillment is enabled for SmallTalk.