Skip to content

Alerts

When you have multiple automations running at the same time, visualizing the entire operation can be a challenge.

Alerts are used to provide short messages that can describe a specific aspect of a given automation.

Alerts can be assigned to users for monitoring more critical processes, notifying them whenever an alert is sent.

Screenshot of the BotCity Orchestrator, showing the Alerts menu. The page displays alerts sent on the platform, filtered by an automation name, in a table format with the columns: Type, Alert, Task ID, Automation, Date. Above the table, search fields and alert filters.

Snippet Generator

Alert manipulation actions can be performed directly on the BotCity Orchestrator platform or via code, using the BotCity Maestro SDK or the BotCity Orchestrator API.

Explore the Snippet Generator button to get code examples that facilitate alert manipulations using the BotCity Maestro SDK. Generate code snippets for the following actions: Informational alert, Warning alert, Error alert and Messages via code.

The generated snippets are available in the Python, Java, JavaScript and TypeScript languages.

Snippet Generator

Alert types

There are three types of alerts available in the BotCity Orchestrator:

🟦 Information Alert: Can be used at strategic points to generate important information for the process.

🟨 Warning Alert: Can be used in more critical situations that require closer attention.

🟥 Error Alert: Can be used when something does not go as expected.

Send alerts

Alerts are sent directly via code, making it possible to fire numerous alerts of different types within the same process.

These alerts are recorded in the BotCity Orchestrator, always linked to a specific task.

In addition to alerts sent directly on the platform, there are also messages. These can be used to send alerts via email to anyone, even if they are outside the BotCity Orchestrator workspace.

Maestro SDK

For more information on how to implement the alerts functionality in code, see the Alerts section of the Maestro SDK.

View alerts

There are two ways to view the alerts sent in the BotCity Orchestrator.

Alerts Menu

When accessing Alerts in the side menu, you will find all alerts sent in the Orchestrator in table format.

You will find the following columns:

  • Type: Shows the alert type (Information, Warning or Error).
  • Alert: Title as a link to access alert details, with the customizable alert message below.
  • Task ID: Identification number of the task that sent the alert, as a link to access task details.
  • Automation: Name of the automation that sent the alert, as a link to access automation details.
  • Date: Date and time the alert occurred.

Screenshot of the BotCity Orchestrator, showing the Alerts menu. The page displays alerts sent on the platform in a table format with the columns: Type, Alert, Task ID, Automation, Date. Each page shows the 10 most recent items, with an option to select the number of rows per page and forward/back navigation buttons at the bottom.

Tasks Menu

Alerts can also be accessed through the Tasks menu, by opening a task's details and navigating to the Alerts tab.

You will find the following columns:

  • Alert type: Type of the generated alert (Information, Warning or Error).
  • Alert: Title as a link to access alert details, with the customizable alert message below.
  • Date: Date and time the alert was generated.

Screenshot of the BotCity Orchestrator, showing the details of a task. The page displays the task ID as the title, on the Alerts tab. The table shows the alerts sent by the task with the columns: Type, Alert and Date.

Alert details

When accessing the details page of an alert, you will find the following information blocks:

  • Type: Alert type with its corresponding icon.
  • Alert Details: Customized title and message of the alert.
  • Automation Information: Automation, Task ID and Repository.
  • Alert Notifications: Fields to select:
    • Users to notify: Select users to receive alerts via email.
    • Notification type: Select which types of notifications should be sent to the selected users.

Screenshot of the BotCity Orchestrator, showing the Alert details. The page displays the title defined in the alert, with a card below containing the information: Details: type, title and message; Automation: automation name, task number and repository; Notifications: User selection option and alert type to notify. Share alert button in the upper right corner.

Share

You can easily share alerts using the share button in the upper right corner.

Screenshot of the BotCity Orchestrator on the Alert details screen. Shows a modal window with the alert sharing information containing a link in a box and a copy link button next to it.

Search and filters

You can combine multiple filters to search in the Alerts menu according to your needs.

Search by:

  • Task ID: Search by task identification.

Available filters:

  • Automation: Select one or more automations.
  • Type: Select a specific alert type.
  • Period: Select a period (1 day, 1 week, 15 days, 1 month).

Sort order:

  • Most recent first
  • Oldest first

GIF of the BotCity Orchestrator, showing the filters for alert search. Displays the three main fields available for filtering: Search by Task ID, Filter, Sort order.