@makehq/sdk
    Preparing search index...

    Type Alias Scenario

    Represents a Make scenario. Scenarios allow you to create and run automation tasks consisting of a series of modules that indicate how data should be transferred and transformed between apps or services.

    type Scenario = {
        created: string;
        createdByUser: { email: number; id: number; name: number };
        customProperties?: Record<string, JSONValue>;
        description: string;
        dlqCount: number;
        folderId: number | null;
        folderPath?: string | null;
        id: number;
        isActive: boolean;
        isinvalid: boolean;
        isPaused: boolean;
        labels?: ScenarioLabel[];
        lastEdit: string;
        name: string;
        operations: number;
        scheduling: Scheduling;
        teamId: number;
        transfer: number;
        updatedByUser: { email: number; id: number; name: number };
        usedPackages: string[];
    }
    Index

    Properties

    created createdByUser customProperties? description dlqCount folderId folderPath? id isActive isinvalid isPaused labels? lastEdit name operations scheduling teamId transfer updatedByUser usedPackages

    Properties

    created: string

    Timestamp when the scenario was created

    createdByUser: { email: number; id: number; name: number }

    Information about the user who created the scenario

    Type declaration

    • email: number

      User email

    • id: number

      User ID

    • name: number

      User name

    customProperties?: Record<string, JSONValue>

    Custom properties defined for the scenario

    description: string

    Description of the scenario

    dlqCount: number

    Count of incomplete executions (DLQ items)

    folderId: number | null

    ID of the folder containing the scenario, or null when the scenario is not in a folder

    folderPath?: string | null

    Slash-separated path of the containing folder (e.g. CRM/cleanup), or null when the scenario is not in a folder. Returned when requested via cols (included by *)

    id: number

    Unique identifier of the scenario

    isActive: boolean

    Whether the scenario is currently active

    isinvalid: boolean

    Whether the scenario has been stopped because of an error

    isPaused: boolean

    Whether the scenario is paused because of the subscription problem

    labels?: ScenarioLabel[]

    Scenario labels assigned to the scenario, sorted by name (empty array when unassigned). Returned when requested via cols (included by *)

    lastEdit: string

    Timestamp of the last edit

    name: string

    Name of the scenario

    operations: number

    Number of operations the scenario consumed in the current period

    scheduling: Scheduling

    Scheduling configuration for the scenario

    teamId: number

    ID of the team that owns the scenario

    transfer: number

    Data transfer consumed in the current period

    updatedByUser: { email: number; id: number; name: number }

    Information about the user who last updated the scenario

    Type declaration

    • email: number

      User email

    • id: number

      User ID

    • name: number

      User name

    usedPackages: string[]

    List of packages/apps used in the scenario

    Settings

    Member Visibility

    On This Page

    Properties