EnterpriseCrmFrontendsEventbusProtoTriggerConfig

import type { EnterpriseCrmFrontendsEventbusProtoTriggerConfig } from "https://googleapis.deno.dev/v1/integrations:v1.ts";

Configuration detail of a trigger. Next available id: 20

interface EnterpriseCrmFrontendsEventbusProtoTriggerConfig {

alertConfig?: EnterpriseCrmEventbusProtoWorkflowAlertConfig[];

cloudSchedulerConfig?: EnterpriseCrmEventbusProtoCloudSchedulerConfig;

description?: string;

enabledClients?: string[];

errorCatcherId?: string;

label?: string;

nextTasksExecutionPolicy?: "UNSPECIFIED" | "RUN_ALL_MATCH" | "RUN_FIRST_MATCH";

pauseWorkflowExecutions?: boolean;

position?: EnterpriseCrmEventbusProtoCoordinate;

properties?: {

[key: string]: string;

};

startTasks?: EnterpriseCrmEventbusProtoNextTask[];

triggerCriteria?: EnterpriseCrmEventbusProtoTriggerCriteria;

triggerId?: string;

triggerName?: string;

triggerNumber?: string;

triggerType?:

| "UNKNOWN"

| "CLOUD_PUBSUB"

| "GOOPS"

| "SFDC_SYNC"

| "CRON"

| "API"

| "MANIFOLD_TRIGGER"

| "DATALAYER_DATA_CHANGE"

| "SFDC_CHANNEL"

| "CLOUD_PUBSUB_EXTERNAL"

| "SFDC_CDC_CHANNEL"

| "SFDC_PLATFORM_EVENTS_CHANNEL"

| "CLOUD_SCHEDULER"

| "INTEGRATION_CONNECTOR_TRIGGER"

| "PRIVATE_TRIGGER";

}

§Properties

alertConfig?: EnterpriseCrmEventbusProtoWorkflowAlertConfig[]

[src]

An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.

cloudSchedulerConfig?: EnterpriseCrmEventbusProtoCloudSchedulerConfig

[src]

description?: string

[src]

User-provided description intended to give more business context about the task.

enabledClients?: string[]

[src]

Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.

errorCatcherId?: string

[src]

Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task

label?: string

[src]

The user created label for a particular trigger.

nextTasksExecutionPolicy?: "UNSPECIFIED" | "RUN_ALL_MATCH" | "RUN_FIRST_MATCH"

[src]

Dictates how next tasks will be executed.

pauseWorkflowExecutions?: boolean

[src]

Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.

position?: EnterpriseCrmEventbusProtoCoordinate

[src]

Optional. Informs the front-end application where to draw this trigger config on the UI.

properties?: {

[key: string]: string;

}

[src]

Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.

startTasks?: EnterpriseCrmEventbusProtoNextTask[]

[src]

Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).

triggerCriteria?: EnterpriseCrmEventbusProtoTriggerCriteria

[src]

Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.

triggerId?: string

[src]

The backend trigger ID.

triggerName?: string

[src]

Optional. Name of the trigger This is added to identify the type of trigger. This is avoid the logic on triggerId to identify the trigger_type and push the same to monitoring.

triggerNumber?: string

[src]

Required. A number to uniquely identify each trigger config within the workflow on UI.

[src]