REST Resource: projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs

Resource: TaskPushNotificationConfig

JSON representation 
{
  "name": string,
  "pushNotificationConfig": {
    object (PushNotificationConfig)
  }
}
Fields
name

string

The resource name of the config. Format: tasks/{taskId}/pushNotificationConfigs/{configId}
pushNotificationConfig

object (PushNotificationConfig)

The push notification configuration details.

PushNotificationConfig

Configuration for setting up push notifications for task updates.

JSON representation 
{
  "id": string,
  "url": string,
  "token": string,
  "authentication": {
    object (AuthenticationInfo)
  }
}
Fields
id

string

A unique identifier (e.g. UUID) for this push notification.
url

string

url to send the notification too
token

string

Token unique for this task/session
authentication

object (AuthenticationInfo)

Information about the authentication to sent with the notification

AuthenticationInfo

Defines authentication details, used for push notifications.

JSON representation 
{
  "schemes": [
    string
  ],
  "credentials": string
}
Fields
schemes[]

string

Supported authentication schemes - e.g. Basic, Bearer, etc
credentials

string

Optional credentials

Methods

create

 Set a push notification config for a task.

delete

 Delete a push notification config for a task.

get

 Get a push notification config for a task.

list

 Get a list of push notifications configured for a task.