Agent

Conversational agent configuration for proxying requests to external webhooks.

Defines the structure, behavior, and webhook integration for an agent that handles user interactions through chat or button triggers, supporting both single-turn and multi-turn conversation patterns.

type Agent {
  id: ID!
  names: [LocalizedString!]!
  descriptions: [LocalizedString!]
  welcomeMessages: [LocalizedString!]
  buttonLabels: [LocalizedString!]
  active: Boolean!
  types: [String!]!
  trigger: AgentTrigger!
  interactionMode: AgentInteractionMode!
  webhookUrl: String!
  webhookTimeoutMs: Int!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdByAdminUserId: Int
  lastModifiedByAdminUserId: Int
}

Fields

Agent.id ● ID! non-null scalar

Unique identifier for the agent.

Agent.names ● [LocalizedString!]! non-null object

Localized display names for the agent.

Agent.descriptions ● [LocalizedString!] list object

Localized descriptions for the agent.

Agent.welcomeMessages ● [LocalizedString!] list object

Localized welcome messages displayed when the agent is activated.

Agent.buttonLabels ● [LocalizedString!] list object

Localized button labels for the agent.

Agent.active ● Boolean! non-null scalar

Whether the agent is currently active and available for interactions.

Agent.types ● [String!]! non-null scalar

Classification types for the agent in SCREAMING_SNAKE_CASE format.

Agent.trigger ● AgentTrigger! non-null enum

Trigger mechanism that activates the agent interaction.

Agent.interactionMode ● AgentInteractionMode! non-null enum

Interaction mode defining the conversational pattern.

Agent.webhookUrl ● String! non-null scalar

URL of the external webhook that processes agent requests.

Agent.webhookTimeoutMs ● Int! non-null scalar

Timeout in milliseconds for webhook requests.

Agent.createdAt ● DateTime! non-null scalar

Timestamp when the agent was created.

Agent.lastModifiedAt ● DateTime! non-null scalar

Timestamp when the agent was last modified.

Agent.createdByAdminUserId ● Int scalar

Admin user ID who created the agent.

Agent.lastModifiedByAdminUserId ● Int scalar

Admin user ID who last modified the agent.

Returned By

agent query ● agentCreate mutation ● agentUpdate mutation

Member Of

AgentResponse object