@servicenow/sdk - v4.7.0
    Preparing search index...

    Type Alias AiAgentTriggerConfigType

    Type representing the properties of a Trigger Configuration (sn_aia_trigger_configuration).

    type AiAgentTriggerConfigType = {
        active?: boolean;
        businessRule?:
            | string
            | Record<"sys_script">
            | ReturnType<typeof BusinessRule>;
        channel: string;
        description?: string;
        domain?: string | "global";
        enableDiscovery?: boolean;
        m2mSysOverrides?: string | Record<"sn_aia_trigger_agent_usecase_m2m">;
        name: string;
        notificationScript?:
            | string
            | Record<"sys_script_client">
            | ReturnType<typeof ClientScript>;
        objectiveTemplate: string;
        portal?: string | Record<"now_assist_deployment_channel">;
        profile?: string | Record<"now_assist_deployment">;
        runAs?: string;
        runAsScript?:
            | ((context: unknown, ...dependencies: unknown[]) => string)
            | string;
        runAsUser?: string | Record<"sys_user">;
        schedule?: ScheduleConfigType;
        showNotifications?: boolean;
        sysOverrides?: string | Record<"sn_aia_trigger_configuration">;
        targetTable: TableName;
        triggerCondition: string;
        triggerFlow?: string | Record<"sys_hub_flow">;
        triggerFlowDefinitionType: TriggerFlowDefinitionType;
        usecase?: string | Record<"sn_aia_usecase">;
        usecaseDiscovery?: boolean;
    }
    Index

    Properties

    active? businessRule? channel description? domain? enableDiscovery? m2mSysOverrides? name notificationScript? objectiveTemplate portal? profile? runAs? runAsScript? runAsUser? schedule? showNotifications? sysOverrides? targetTable triggerCondition triggerFlow? triggerFlowDefinitionType usecase? usecaseDiscovery?

    Properties

    active?: boolean

    Whether the trigger is active (defaults to false)

    businessRule?: string | Record<"sys_script"> | ReturnType<typeof BusinessRule>

    Business rule to execute when triggered

    channel: string

    Messaging channel for the trigger (defaults to Now Assist Panel)

    description?: string

    Description of the trigger

    domain?: string | "global"

    Domain ID

    enableDiscovery?: boolean

    Whether to enable trigger discovery (defaults to false)

    m2mSysOverrides?: string | Record<"sn_aia_trigger_agent_usecase_m2m">

    Reference to override the trigger-agent-usecase mapping (sn_aia_trigger_agent_usecase_m2m)

    name: string

    Name of the trigger

    notificationScript?:
        | string
        | Record<"sys_script_client">
        | ReturnType<typeof ClientScript>

    Client script for handling notifications

    objectiveTemplate: string

    Template for the objective message (defaults to "Help me resolve ${number}")

    portal?: string | Record<"now_assist_deployment_channel">

    Now Assist deployment channel

    profile?: string | Record<"now_assist_deployment">

    Now Assist deployment profile

    runAs?: string

    Field name to use for determining the run-as user

    runAsScript?:
        | ((context: unknown, ...dependencies: unknown[]) => string)
        | string

    Script to determine which user to run as

    runAsUser?: string | Record<"sys_user">

    Reference to User who runs the trigger (user sys_id or Record<'sys_user'>)

    schedule?: ScheduleConfigType

    Schedule configuration - used for scheduled triggers (scheduled, daily, weekly, monthly)

    showNotifications?: boolean

    Whether to show notifications when the trigger fires

    sysOverrides?: string | Record<"sn_aia_trigger_configuration">

    Reference to another trigger configuration to override

    targetTable: TableName

    Table that the trigger monitors

    triggerCondition: string

    Condition that determines when the trigger fires (encoded query)

    triggerFlow?: string | Record<"sys_hub_flow">

    Flow to execute when triggered

    triggerFlowDefinitionType: TriggerFlowDefinitionType

    Type of trigger flow definition

    usecase?: string | Record<"sn_aia_usecase">

    Use case associated with this trigger

    usecaseDiscovery?: boolean

    Whether to enable use case discovery

    Settings

    Member Visibility

    On This Page

    Properties