​
Overview

Actions allow you to create automated workflows and integrations within Glean. This guide walks through the process of creating and configuring an Action.

You must have a Glean admin or app developer role to create actions.

To get started, navigate to Admin console > Platform > Actions where you’ll see a list of all available actions. Click the “New Action” button in the top right corner to begin.

You can choose to create a custom action from scratch, build a simple redirect action or pick from one of the available out-of-the-box actions (if enabled for you).

For Gmail or Jira creation actions, you can use built-in templates with no coding required. For other use cases, you can create custom actions from scratch.

If you select creating an action from scratch, these are the steps to create an action:

1

Basic Information

Start by providing the essential details to identify your action:

​
Display name
string
required

The name that will be shown in the actions directory

​
Display description
string
required

A clear description of what your action does

​
Unique identifier
string
required

A unique identifier to distinguish your action from others with similar names

​
Action type
string
required

Choose between:

  • Action: Performs operations in external apps
  • Retrieval: Fetches information from external applications

Action Types in Detail

Action

Helps users perform operations in external apps. Can be either:

  • Execution: Performs the action directly within Glean
  • Redirect: Sends users to the appropriate external URL

Retrieval

Fetches information from external applications that may or may not be indexed with Glean

2

Trigger Condition

Configure when your action should be triggered in Glean Chat.

When users interact with Glean Chat, the system matches their requests against the trigger conditions to determine which action to use.

For example, for an IT support Action, you might include trigger conditions like: “Creates IT support tickets on JIRA. Use this action when the user wants to create a support ticket, needs access to something or wants help with any IT related issues.”

You can also provide example queries such as:

  • “I forgot my password for Notion”
  • “Need to reset my password for gmail”
  • “I need access to gong”
3

Functionality

Define the specific configurations for your action.

For actions created from scratch, you’ll need to upload an API spec:

4

Authentication

This step is only required for actions with a server.

Configure how Glean should pass authentication information for requests coming from Glean to your action’s server.

​
Testing and Deployment

​
Testing Your Action

After saving your action, use the testing link provided at the bottom of the page to verify its functionality. Test with various queries that should trigger the action and refine the Trigger Condition if needed.

​
Deployment Options

Actions can be deployed in two environments:

Chat Deployment

Deploy to all users (recommended after thorough testing) or a subset of users for testing

Glean Apps

Deploy as part of Glean Apps integration

​
API Specification Configuration

This section only applies to custom actions built from scratch.

When configuring the API spec for your action, provide a YAML or JSON file that follows these requirements:

  • Contains a single endpoint defined in /paths (e.g., /execute)
  • Fields should be added in either requestBody.content or parameters
  • All fields must follow this format:
    • No nested fields (only string/number/integer/boolean or arrays of these types)
    • Use enum with a single value for fixed values
    • Assistant can guess non-fixed values
    • Mark required fields using standard OpenAPI specifications

For example implementations and API specs, refer to our examples documentation.

Was this page helpful?

Suggest editsRaise issue