Type Alias TriggerCreateParams

TriggerCreateParams: {
    display_name?: string;
    environment_id?: string;
    execution_timeout_seconds?: number;
    interaction: CreateAgentInteraction;
    max_consecutive_failures?: number;
    schedule: string;
    time_zone: string;
}

Parameters for creating a trigger.

Type declaration

  • Optionaldisplay_name?: string

    Optional. The display name of the trigger.

  • Optionalenvironment_id?: string

    Optional. The environment ID for the trigger execution.

  • Optionalexecution_timeout_seconds?: number

    Optional. The execution timeout for the triggered interaction.

  • interaction: CreateAgentInteraction

    Interaction for generating the completion using agents.

  • Optionalmax_consecutive_failures?: number

    Optional. The maximum number of consecutive failures allowed before

    Remarks

    the trigger is automatically paused (status becomes ERROR).

  • schedule: string

    Required. The cron schedule on which the trigger should run.

    Remarks

    Standard cron format.

  • time_zone: string

    Required. Time zone in which the schedule should be interpreted.

Settings