Automations

The Automations component lets you review and manage schedule and alert automations directly inside your GoodData applications. It handles data loading, permission checks, and bulk actions while staying configurable through props and context providers. The list shows one automation type at a time: schedules by default, or alerts when you pass type="alert".

Features

• Inspect automations at workspace or organization scope from a single React component
• Filter by dashboard, workspace, recipients, status, or owner depending on scope
• Sort results by title or last execution and search within the visible list
• Perform pause, resume, unsubscribe, and delete operations (single item or bulk)
• Customize visible columns, default filters, and list dimensions to fit your layout
• Plug into custom dashboard/widget routing through URL builder callbacks
• Localize UI labels and date formatting via locale and timezone props

Basic integration example

import { Automations } from "@gooddata/sdk-ui-ext";

// Import required styles
import "@gooddata/sdk-ui-ext/styles/css/main.css";

function WorkspaceAutomations({ backend, workspace }) {
    return <Automations backend={backend} workspace={workspace} scope="workspace" />;
}

Wrap the component with BackendProvider, WorkspaceProvider or OrganizationProvider if you prefer context-based configuration instead of passing props explicitly.

Filter availability and defaults

Filtering options depend on the selected scope. When you omit availableFilters, the component uses these defaults:

Adjust the set with the availableFilters prop and pre-populate UI controls with preselectedFilters. The preselectedFilters keys are the filter names plus externalRecipients; each value is an array of { value, label? } objects:

import { Automations } from "@gooddata/sdk-ui-ext";

function OrganizationAutomations({ backend, organization }) {
    return (
        <Automations
            backend={backend}
            organization={organization}
            scope="organization"
            availableFilters={["workspace", "status"]}
            preselectedFilters={{
                status: [{ value: "FAILED", label: "Failed" }],
            }}
        />
    );
}

Sorting and search

The list sorts by title (ascending by default); the title column header toggles the direction, and the component keeps the choice in its internal state. Combine sorting with the built-in search box (which matches the title) and filters to narrow long lists quickly.

Column customization

Tailor the table layout with selectedColumnDefinitions:

const customColumns = [
    { name: "title", width: 320 },
    { name: "dashboard" },
    { name: "recipients" },
    { name: "state" },
    { name: "lastRun" },
];

<Automations
    backend={backend}
    workspace={workspace}
    scope="workspace"
    selectedColumnDefinitions={customColumns}
/>;

Columns accept optional width and minWidth hints (pixels). Omit a column from this array to hide it from the list.

When you omit selectedColumnDefinitions, the component uses these defaults per scope:

Every column is available in both scopes; the workspace column is only useful at organization scope. Columns marked schedule-only (attachments, nextRun) have no value for alerts:

Actions, bulk actions, and callbacks

Automations bundle built-in handlers for destructive and maintenance actions such as:

• Delete single or multiple automations
• Pause or resume selected automations
• Unsubscribe users from notifications

Override the editAutomation callback to trigger custom edit flows (for example, open a side panel).

To refresh the list after external updates, increment the externalInvalidationId prop. The component ignores 0 or undefined, so start at 0 and increment when a reload is needed:

const [invalidationId, setInvalidationId] = useState(0);

// After external update (for example, delete via API)
setInvalidationId(invalidationId + 1);

<Automations
    backend={backend}
    workspace={workspace}
    scope="workspace"
    externalInvalidationId={invalidationId}
/>;

Notes

• Provide both BackendProvider and WorkspaceProvider/OrganizationProvider so the component can derive context automatically.
• Align pageSize (default 30) with maxHeight (default 500 pixels) so a page of rows fills the visible area.
• Set locale (default en-US) and timezone (default UTC) to match your organization, workspace, or user settings for consistent formatting.
• Automations is @internal, so its props are not published in the API reference. For the current list of props and defaults, see IAutomationsProps in the @gooddata/sdk-ui-ext source, under src/automations/types.ts.