Scenarios in Brightsy AI are predefined interactions that can be triggered manually, on a schedule, or via webhooks. This guide will walk you through the process of managing scenarios, which are essential components for configuring and executing tasks within the application.
Table of Contents
- Accessing Scenarios
- Creating a New Scenario
- Editing an Existing Scenario
- Deleting a Scenario
- Understanding Scenario Fields
- Troubleshooting
1. Accessing Scenarios
To manage scenarios, navigate to the "Scenarios" section of your account dashboard. Here, you will see a list of all existing scenarios associated with your account.
Scenario Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the scenario | Auto-generated | Read-only |
| name | string | Name of the scenario | Yes | 2-50 characters |
| description | string | Description of the scenario's purpose | Yes | Max 5000 characters |
| status | enum | Current state of the scenario | Yes | Values: "disabled", "enabled" |
| agentId | string | ID of the agent handling this scenario | Yes | Must exist in the system |
| instruction | string | Detailed steps or guidelines for the scenario | Yes | Max 5000 characters |
| exampleBody | object | Sample JSON payload for the scenario | Yes | Valid JSON format |
| createdAt | datetime | When the scenario was created | Auto-generated | Read-only |
| updatedAt | datetime | When the scenario was last updated | Auto-generated | Read-only |
2. Creating a New Scenario
- Navigate to Scenarios: Go to the "Scenarios" section from your account dashboard.
- Click "Create New Scenario": This button is usually located at the top right of the scenarios list.
- Fill in the Scenario Details: Enter the necessary information such as Name, Description, Status, and other required fields.
- Select an Agent: Choose an agent from the dropdown list that will handle this scenario.
- Add Instructions and Example Body: Provide detailed instructions and an example JSON body for the scenario.